Gitbook PlantUml plugin is used to select from markdown uml and converting it into a picture format svg.
Branch: master
Clone or download
romanlytkin Merge pull request #2 from Alsan/master
Generate svg under _book
Latest commit a0f675d Mar 12, 2015
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
book gitbook-plantUML v1.0 21.10.14 Oct 21, 2014
images gitbook-plantUML v1.0 21.10.14 Oct 21, 2014
LICENSE gitbook-plantUML v1.0 21.10.14 Oct 21, 2014
README.md Update README.md Dec 8, 2014
index.js generate svg under _book Jan 11, 2015
package.json merge with upstream Jan 11, 2015

README.md

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.