sirianni/plantuml-markdown

Parse UML tags in markdown, convert markdown to html or docx

plantuml-markdown

Parse plantuml tags in markdown file, convert markdown to html/docx

Use this block in markdown to include UML image. uml ......

Use this line to include file content in local disk. !INCLUDE "/path/file"

Preview

Example

Markdown

### Title3
#### Title4

line1

line2

```uml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
```

Show as:

Title3

Title4

line1

line2

Install

1. Download and Install plantuml

2. Config some parameters in "preprocess.py"

   • plantuml_jar_file -- Where is plantuml.jar
   • plantuml_jar_parameters
   • pandoc_exe_file -- Where is the pandoc execute file
   • pandoc_html_parameters -- pandoc's parameters for html
   • pandoc_css_file -- CSS file for html, see "--css" in pandoc
   • pandoc_reference_docx -- local docx template file, see "--reference-docx" in pandoc

3. Finally, "python preprocess.py [--plantuml-jar /pathto/plantuml.jar] [--reference-docx /pathto/reference.docx] markdown_file"

Document

• PlantUML Language Reference Guide