0.0.15 • Published 11 years ago
gitbook-plugin-plantuml v0.0.15
GitBook PlantUml Plugin
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:
Image uml.
How to use it:
Gitbook PlantUml plugin can be installed from NPM using:
$ npm install gitbook-plugin-plantuml
Configure plugin in book.json
.
{
"plugins": ["plantuml"]
}
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
Additional requirements:
- Create a directory /assets/images/uml in the root of your project.
- Install PlantUML. (Download plantuml.jar to root path)
For Mac OS X users. Install graphviz package.
$ brew install graphviz