mkdocs_puml is a fast and simple package that brings plantuml diagrams to MkDocs
documentation.
Quick Start
Run the following command to install the package
pip install mkdocs_puml
After that, add plantuml plugin into plugins section of your mkdocs.yml file,
in order to use PlantUML with MkDocs.
plugins:
- plantuml:
puml_url: https://www.plantuml.com/plantuml/
Not include PlantUML code fences with puml keyword to your documentation, such as
```puml
@startuml
Bob -> Alice : hello
@enduml
```
That's it, mkdocs_puml will automatically build SVG diagrams from the code 🎉
For more information, please refer to the documentation.
License
This project is licensed under MIT license.
1 maintainer
Metadata
1 maintainer
Release files for mkdocs_puml 2.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_puml-2.3.0.tar.gz | 14.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_puml-2.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 31.7 kB
Release files / mkdocs_puml-2.3.0.tar.gz
| Download URL | mkdocs_puml-2.3.0.tar.gz |
|---|---|
| Size | 14.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
51c7f742eb6384e4e48db880a638869dff9b39a7d42cc42d86aaf25f0ffdb5aa
|
|
BLAKE2b-256 checksum How to use checksums |
4c61f742f25cb6c301bf283355bcf0e9db0e5d0c9217a7e5deb97f8684bf3097
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.4 CPython/3.12.3 Linux/6.8.0-47-generic
|
Release files / mkdocs_puml-2.3.0-py3-none-any.whl
| Download URL | mkdocs_puml-2.3.0-py3-none-any.whl |
|---|---|
| Size | 17.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8fb6a3bceaa9d20020d274b5b6d8acd2f18b809511604c0d2fcb450ac3f3a160
|
|
BLAKE2b-256 checksum How to use checksums |
124f8db4743bbe04a9e2ee09cddacf2b7ffd5e214899a974481fb1481de44711
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.4 CPython/3.12.3 Linux/6.8.0-47-generic
|
