mkdocs_puml
is a fast and simple package that brings plantuml diagrams to MkDocs
documentation.
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.
This project is licensed under MIT license.