https://github.com/mikhailkravets/mkdocs_puml

Inline PlantUML diagrams in your MkDocs documentation
https://github.com/mikhailkravets/mkdocs_puml

diagrams documentation inline mkdocs plantuml

Last synced: 4 days ago
JSON representation

Inline PlantUML diagrams in your MkDocs documentation

• Host: GitHub
• URL: https://github.com/mikhailkravets/mkdocs_puml
• Owner: MikhailKravets
• License: mit
• Created: 2022-09-11T16:37:25.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-25T11:23:21.000Z (2 months ago)
• Last Synced: 2024-12-30T11:58:10.706Z (4 days ago)
• Topics: diagrams, documentation, inline, mkdocs, plantuml
• Language: Python
• Homepage: https://mikhailkravets.github.io/mkdocs_puml/
• Size: 5.1 MB
• Stars: 34
• Watchers: 4
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![logo](https://mikhailkravets.github.io/mkdocs_puml/assets/logos/logo.svg)
















`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

```shell

pip install mkdocs_puml

```

After that, add `plantuml` plugin into `plugins` section of your `mkdocs.yml` file,

in order to use PlantUML with MkDocs.

```yaml

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**](https://mikhailkravets.github.io/mkdocs_puml/).

## License

This project is licensed under MIT license.