diff --git a/docs-src/02-markdown/03-plantuml-diagrams.md b/docs-src/02-markdown/03-plantuml-diagrams.md new file mode 100644 index 0000000..b1811b5 --- /dev/null +++ b/docs-src/02-markdown/03-plantuml-diagrams.md @@ -0,0 +1,33 @@ +--- +title = "PlantUML Diagrams" +--- + +If you have [PlantUML](http://plantuml.com/) installed and available on your path, _mkbook_ will try to render any code blocks with a language tag of `plantuml` as inline SVG images. + +For example: + +~~~ +```plantuml +@startuml +Alice -> Bob: Authentication Request +Bob --> Alice: Authentication Response + +Alice -> Bob: Another authentication Request +Alice <-- Bob: Another authentication Response +@enduml +``` +~~~ + +is rendered as: + +```plantuml +@startuml +Alice -> Bob: Authentication Request +Bob --> Alice: Authentication Response + +Alice -> Bob: Another authentication Request +Alice <-- Bob: Another authentication Response +@enduml +``` + +This feature is still experimental, but I find it handy for my books. diff --git a/docs/01-introduction/index.html b/docs/01-introduction/index.html index 49f79e6..6f2dcf5 100644 --- a/docs/01-introduction/index.html +++ b/docs/01-introduction/index.html @@ -12,7 +12,7 @@ - +