Skip to content

Latest commit

 

History

History
77 lines (45 loc) · 2.02 KB

README.md

File metadata and controls

77 lines (45 loc) · 2.02 KB
Raw

title: 'plantuml-markdown README' ...

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 pandoc, An old version already in the "prerequisite" directory.

  2. Download and Install graphviz, An old version already in the "plantuml" directory.

  3. Config some parameters in "preprocess.py"

    • plantuml_jar_file -- Where is plantuml.jar, An old version already in the "plantuml" directory.
    • plantuml_jar_parameters -- default NULL
    • 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

  4. Finally, "python preprocess.py [--plantuml-jar /path-to/plantuml.jar] [--reference-docx /path-to/reference.docx] markdown_file"

Document