romanlytkin / gitbook-plantuml

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

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:

@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:

Gitbook PlantUml plugin can be installed from NPM using:

$ npm install gitbook-plantuml

Additional requirements:

• Create a directory /assets/images/uml in the root of your project.
• Install PlantUML.