CLI helper for managing PlantUML diagram sources and their previews in Markdown files
CLI helper for managing PlantUML diagram sources and their previews in Markdown files
PlantUML is a great tool for managing software spec diagrams. Unless you are on GitLab, which has built-in support for interpreting PlantUML diagram sources you need to get hacky and inconvenient and even more so for private repos.
Plantaznik is a tool you can integrate into your workflow, that does the menial job for you: find referenced PlantUML sources, generate links and update in the Markdown docs.
In your Markdown files, include the following declarations in the comment:
md
<!-- plantaznik:./path/to/plantuml/source.plantuml -->
EMPTY_OR_PLACEHOLDER_LINE_THAT_WILL_GET_REPLACED
The declarations include a path to the source file, which is relative to the current file.
$ plantaznik '**/*.md'
All targeted input files (assume utf8 encoded markdown files with \n lines) are processed and the lines following the declerations are replaced by a Markdown syntax image, pointing to official PlantUML server with your source code encoded in the link.