docsify-puml
v1.1.1
Docsify plugin to parse PlantUML content
0/weekUpdated 3 years agoMITUnpacked: 126.4 KB
Published by rochajg
npm install docsify-pumlDocsify PUML
Docsify plugin to parse PlantUML content
Install •
Usage •
Options •
Examples •
Meta •
Contributing
---
Install
It's just simple like insert that into your
index.html``html`
...
See Options for more details.
Usage
There are two ways to use that in your documentations. You can write directly into your markdown doc or you can import that from an external .puml file.
$3
Just create an code block with plantuml at lang type.
Ex.:
``markdown$3
`plantuml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
`
$3
To include a .puml file into your doc, need to use an sitaxe like the !include from default PUML, but surrounded by [[ and ]].
Ex.:
``markdown$3
`plantuml
@startuml
[[!include ../assets/pumls/my-chart.puml]]
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
`
Options
At now, that are options we have, with default their values:
`json`
{
"skin": "default",
"renderAsObject": false,
"asLink": false,
"serverPath": "https://custom-server.local/plantuml/png/"
}
$3
That param says what skin(theme) should use in all plantuml blocks. By default, it's default, an clean implementation created by @matthewjosephtaylor.
| Value | Description |
| ---------------------------------------- | :-------------------------------------------------------- |
| default | An clean implementation |classic
| | Default ~~ugly~~ PlantUML theme |./assets/local-puml-theme.pu
| | An string pointing to a local file with your custom theme |https://external.link/my-puml-theme.pu
| | An url to a external server hosting a theme |
$3
That param says if any rendered object will be inside a tag (if true) or inside a tag (if false).
That second option is most used when you want to interact with generated svg, like using links. To use with an link, for example, should be like that:
``markdown`plantuml`
@startuml
Alice -> Bob: Authentication Request [[$./other-file docs]]
Bob --> Alice: Authentication Response [[$../other-file docs]]
@enduml
> Note: Is VERY IMPORTANT use an $ to say that is a link.
$3
That param says if your generate image would be a link to open on blank page. By default it's false.
> Note: Using with an tag still not work properly.
$3
That param says what server should use to render the svg. By default, use the official PlantUML server. If you're using an own server, set in this option.
Examples
For now, has three examples into examples folder:
- Basic - with an in code implementation;
- Themeable - with a theme implementation (from external source theme);
- Import PUML - with implementation using an .puml file;
Meta
Indie Atom – indieatom@gmail.com
> This repo is completelly based on @imyelo docsify-plantuml version.
Distributed under the MIT license. See LICENSE for more information.
Contributing
1. Fork it (
2. Create your feature branch (git checkout -b feature/fooBar)git commit -am 'Add some fooBar'
3. Commit your changes ()git push origin feature/fooBar`)
4. Push to the branch (
5. Create a new Pull Request