README.md

MkDocs Material + PlantUML

A distribution combining mkdocs-material and PlantUML.

Quick start

Follow the setup instructions from mkdocs-material. Add plantuml-markdown to the markdown_extensions list in mkdocs.yml.

markdown_extensions:
    - plantuml-markdown

Then launch the container with:

docker run -it --rm -p 8000:8000 -v ${PWD}:/docs amarraja/mkdocs-material-plantuml

And navigate to http://localhost:8000/

Add a UML block like so:

```plantuml
  Goofy ->  MickeyMouse: calls
  Goofy <-- MickeyMouse: responds
```

UML will be rendered as an inline image:

Further examples

See examples at mikitex70/plantuml-markdown and PlantUML

Credits

• squidfunk/mkdocs-material
• mikitex70/plantuml-markdown
• PlantUML