PlantUml Plugin for Honkit and GitBook.
This is a sample plugin for GitBook Honkit and is specially adapted for GitBook Honkit from PlantUML. Gitbook Honkit PlantUml plugin is used to select from markdown uml and converting it into a picture format svg.
Install honkit instead of gitbook-cli(deprecated).
Install JRE or JDK please. Ensure your system have java.
It will download plantuml jar file automatically, so in some country and region you must install it behind a proxy, or it will download fail.
Gitbook PlantUml plugin can be installed from NPM using:
npm install gitbook-plugin-umlAdd this plugin into book.json.
{
"plugins": ["uml"]
}Important:
** Please ensure your system have java!!! Or this plugin may not work, and get Error: spawn java ENOENT
** It will download plantuml jar file automatically, so in some country and region you must install it behind a proxy, or it will download fail.
- Support HTML, PDF, EPUB output(make sure your gitbook support SVG)
- Support
```flow code block quote - Multi code style support
To include a PlantUML diagram, just wrap your definition in a "uml" code block. For example:
Text format uml:
```uml
@startuml
Class Stage
Class Timeout {
+constructor:function(cfg)
+timeout:function(ctx)
+overdue:function(ctx)
+stage: Stage
}
Stage <|-- Timeout
@enduml
```
And what's more, puml and plantuml code block also OK.
```puml
@startuml
Class Stage
Class Timeout {
+constructor:function(cfg)
+timeout:function(ctx)
+overdue:function(ctx)
+stage: Stage
}
Stage <|-- Timeout
@enduml
```
Also you can put in your book block as
{% uml %}
@startuml
Class Stage
Class Timeout {
+constructor:function(cfg)
+timeout:function(ctx)
+overdue:function(ctx)
+stage: Stage
}
Stage <|-- Timeout
@enduml
{% enduml %}The block syntax also allows for a src attribute to import an external PlantUml file.
{% uml src="test.plantuml" %}{% enduml %}
Of course, you can also pass the parameters like this.
```puml { src="test.plantuml" }
```
book.json add the uml options
Configure plugin in book.json.
"pluginsConfig": {
"uml": {
"format": "png",
"nailgun": false
}
}This plugin only works in your local machine. You need to play with local gitbook (command-line tool) to pre-compile all uml images.
gitbook serve yourbook
or
gitbook build yourbook
For Mac OS X users. Install graphviz package.
brew install graphvizFor Linux users, Install graphviz package.
sudo apt install graphvizsudo yum install graphvizDebian/Ubuntu users may need install default-jre prevent Error: spawn java ENOENT.
sudo apt-get install default-jreThis plugin original from lyhcode/gitbook-plugin-plantuml
These plugins are also available on honkit.
| Plugin | Description |
|---|---|
| gitbook-plugin-uml | A plug-in that use plantuml to draw beautiful pictures |
| gitbook-plugin-wavedrom | A plug-in that can draw waveforms and register tables |
| gitbook-plugin-sequence | A plug-in that can draw sequence diagrams |
| gitbook-plugin-flow | A plug-in that can draw flowchart.js diagrams |
| gitbook-plugin-echarts | A plug-in that can draw various charts such as bar/pie |
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent