Plant UML diagram-cli
Easily create diagrams for your github repository.
Command line interface for generating diagrams from plant uml files in a convention based way and displaying them in markdown documents
What does it do?
diagrams init creates a
./diagrams folder populated with some default folders like below.
root # your root folder - diagrams # all diagrams in here - diagrams.yml # config file - README.md # readme file with all diagrams displayed as pngs - img # images are generated to here - puml # all diagram files go in here - hbs # template for generated markdown
Running a further command of
diagrams make generates any files in the
.png files in the
It also creates a
README.md in the root of
./diagrams and populates it with links to the
.png files so they automatically appear in your github repository. All you have to do is add a link in your front page of your github with something like
Using the npm package
# install the cli globally npm install -g diagram-cli # show usage diagrams --help # initialise folders and files diagrams init # generate diagrams diagrams make
# You need to have graphviz installed to generate diagrams choco install javaruntime choco install graphviz # Add the path to your environment variables # C:\Program Files (x86)\Graphviz2.38\bin
# You need to have graphviz installed to generate diagrams brew install graphviz
Libraries and useful links
- Should JS docs
- Add description markdown files that get build in tandem
- Add a server to serve as a website