robbell / plantuml-githook

A Git hook which spots PlantUML source files and generates diagrams in a structured way

PlantUML generation Git hook

A Git hook which spots PlantUML source files and generates diagrams in a structured way.

How it works

1. Finds any staged *.puml during a commit
2. Generates diagrams into /docs/assets
3. Includes the generated diagrams in the same commit

Future additions

• Generate diagrams only for files which have changed
• git add for generated files only, not whole folder
• Installation of hooks using GitHooks
• Inline diagrams in Markdown
• Ad-hoc runs