Modified version of Gitbook PlantUml plugin. Originally from
This is a sample plugin for GitBook and is specially adapted for GitBook from PlantUML. Gitbook PlantUml plugin is used to select from markdown uml and converting it into a picture format svg.
Example:
Text format uml:
```plantuml
@startuml
Class Stage
Class Timeout {
+constructor:function(cfg)
+timeout:function(ctx)
+overdue:function(ctx)
+stage: Stage
}
Stage <|-- Timeout
@enduml
```
Image uml.
-
Environment requirements
- Java
- Graphviz
-
Configure plugin in
book.json
.
{
"plugins": [
"plantuml@git+https://github.com/binwin20/gitbook-plugin-plantuml.git"
]
}
-
Install plugins from NPM
$ gitbook install
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
- Integerate with docker image billryan's docker-gitbook to make it buildable