Amos-li / gitbook-plugin-plantuml

Gitbook PlantUml plugin is used to select from markdown uml and converting it into a picture format svg.

GitBook PlantUml Plugin

Modified version of Gitbook PlantUml plugin. Originally from

• lyhcode's version
• andrescamera's version

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.

How to use it

0. Environment requirements

   • Java
   • Graphviz

1. Configure plugin in book.json.

{
    "plugins": [
        "plantuml@git+https://github.com/binwin20/gitbook-plugin-plantuml.git"
    ]
}

2. 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

TODO

• Integerate with docker image billryan's docker-gitbook to make it buildable