https://github.com/vowstar/gitbook-plugin-uml
PlantUml plugin of gitbook/honkit which can draw UML graph in both markdown HTML and PDF
https://github.com/vowstar/gitbook-plugin-uml
gitbook honkit honkit-plugin plantuml
Last synced: about 1 year ago
JSON representation
PlantUml plugin of gitbook/honkit which can draw UML graph in both markdown HTML and PDF
- Host: GitHub
- URL: https://github.com/vowstar/gitbook-plugin-uml
- Owner: vowstar
- License: apache-2.0
- Created: 2016-10-19T05:13:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-03T08:30:04.000Z (about 2 years ago)
- Last Synced: 2024-04-14T19:03:03.453Z (about 2 years ago)
- Topics: gitbook, honkit, honkit-plugin, plantuml
- Language: JavaScript
- Homepage:
- Size: 1.2 MB
- Stars: 32
- Watchers: 5
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gitbook-plugin-uml
[](https://github.com/vowstar/gitbook-plugin-uml/actions)
[](https://coveralls.io/github/vowstar/gitbook-plugin-uml?branch=master)
[](https://www.npmjs.org/package/gitbook-plugin-uml)
[](https://www.npmjs.org/package/gitbook-plugin-uml)
[PlantUml](http://www.plantuml.com/) Plugin for [Honkit](https://github.com/honkit/honkit) ~~and [GitBook](https://github.com/GitbookIO/gitbook)~~.
This is a sample plugin for ~~GitBook~~ Honkit and is specially adapted for ~~GitBook~~ Honkit from [PlantUML](http://www.plantuml.com/index.html). ~~Gitbook~~ Honkit PlantUml plugin is used to select from markdown uml and converting it into a picture format svg.
## Installation
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:
```bash
npm install gitbook-plugin-uml
```
Add this plugin into ``book.json``.
```json
{
"plugins": ["uml"]
}
```
## FAQ
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.
## Features
* Support HTML, PDF, EPUB output(make sure your gitbook support SVG)
* Support `` ``` ``flow code block quote
* Multi code style support
## Beautiful UML
## How to use it
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
```markdown
{% 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.
```text
{% uml src="test.plantuml" %}{% enduml %}
```
Of course, you can also pass the parameters like this.
```puml { src="test.plantuml" }
```
## Configuration
book.json add the uml options
Configure plugin in `book.json`.
```json
"pluginsConfig": {
"uml": {
"format": "png",
"nailgun": false
}
}
```
## Build and serve
This plugin only works in your local machine. You need to play with local `gitbook` (command-line tool) to pre-compile all uml images.
```terminal
gitbook serve yourbook
```
or
```terminal
gitbook build yourbook
```
## Additional requirements
For Mac OS X users. Install *graphviz* package.
```bash
brew install graphviz
```
For Linux users, Install *graphviz* package.
```bash
sudo apt install graphviz
```
```bash
sudo yum install graphviz
```
Debian/Ubuntu users may need install ``default-jre`` prevent Error: spawn java ENOENT.
```bash
sudo apt-get install default-jre
```
## Thanks
This plugin original from [lyhcode/gitbook-plugin-plantuml](https://github.com/lyhcode/gitbook-plugin-plantuml)
## See also
These plugins are also available on honkit.
| Plugin | Description |
| ----------------------------------------------------------------------------- | ------------------------------------------------------ |
| [gitbook-plugin-uml](https://github.com/vowstar/gitbook-plugin-uml) | A plug-in that use plantuml to draw beautiful pictures |
| [gitbook-plugin-wavedrom](https://github.com/vowstar/gitbook-plugin-wavedrom) | A plug-in that can draw waveforms and register tables |
| [gitbook-plugin-sequence](https://github.com/vowstar/gitbook-plugin-sequence) | A plug-in that can draw sequence diagrams |
| [gitbook-plugin-flow](https://github.com/vowstar/gitbook-plugin-flow) | A plug-in that can draw flowchart.js diagrams |
| [gitbook-plugin-echarts](https://github.com/vowstar/gitbook-plugin-echarts) | A plug-in that can draw various charts such as bar/pie |