docsify-plantuml
v1.3.2
plantuml plugin of docsify
43/weekUpdated 3 years agoMITUnpacked: 315.2 KB
Published by yelo
npm install docsify-plantumldocsify-plantuml
Install
1. Configure docsify-plantuml (optional):
``html`
See Options for more details.
2. Insert script into docsify document:
`html`
Usage
Write your plantuml code into a code block marked
plantuml:``markdown
$3
`plantuml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication ResponseAlice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
`
Options
skin
By default, we set the skin of the plantuml to a cleaner version for you.
However, You can still switch with this option () if you prefer the classic one.All available values are:
-
default
- For example:
serverPath
By default, the official PlantUML server is used. If you have your own, configure it using the option:`
renderSvgAsObject
By default, the svg is renderd inside an tag.
If you want interactive svg (like links) configure the renderSvgAsObject option:
This will render like:
Please note that relative urls should start with
markdown
`plantuml
@startuml
Alice -> Bob: Authentication Request [[$./other-file docs]]
Bob --> Alice: Authentication Response [[$../other-file docs]]
@enduml
`
Example
$3
- index.html
- README.md
$3
- index.html
Related
- docsify
- PlantUML
License
MIT © yelo, 2017 - present