puml-for-markdown
Simple CLI Usage
Just run puml-for-markdown in any directory where you have markdown files and it will render links to PlantUML files in markdown comments. PlantUML files allow you to create diagrams that are defined using a simple and intuitive language. By default the entire directory is recursively searched, automatically ignoring anything in the gitignore file.
Examples
The following examples are of a project I worked on, yellow components will link you to another diagram. Obviously the diagram content has been obfuscated.
Embed a Diagram
You can easily add an embedded diagram to your markdown. Simply add a link to the puml file in a markdown comment like so:
<!---->
Here's the result. Try clicking on the yellow blocks.
Link Only
To render a link to a puml diagram, do the same thing but exclude the !
<!--[Click to Open Interactive Diagram](./puml/level_1_system_view.puml)-->
which renders into
Click to Open Interactive Diagram
Goal
The goal is to make PlantUML diagrams easily accessible from markdown, specifically GitHub flavored.
- Should work with both private and public repositories
- Should not have to use tokens to get it to work with private repositories
- Should support hyperlinking to other diagrams
- Should support PlantUML
!include - Should support PlantUML sprites (small graphic images)
- Any time you make changes to diagrams you should be able to run the CLI tool to update the markdown links
Background
PlantUML allows you to create diagrams that are defined using a simple and intuitive language. PlantUML diagrams are great for designing new projects but they don't work very well in Github markdown preview. There are some workarounds, but I found these to be unstable and they have a lot of caveats.
Update: Github released support for embeddable Mermaid diagrams, but PlantUML is still unsupported, see here for more info.
Basic Usage
Whenever you run the CLI it will add a tinyurl link to the rendered SVG next to the markdown comments referencing a puml diagram. E.g.
<!--[Example With Only Link](./puml/level_1_system_view.puml)-->
will be replaced with
[Example With Only Link](https://tinyurl.com/yfpclfpp)<!--[Example With Only Link](./puml/level_1_system_view.puml)-->
When ! is included in front of the markdown link, it will render the diagram image in the markdown. If the image is clicked it will open up the diagram. E.g.
<!---->
will be replaced with
[](https://tinyurl.com/yfpclfpp)<!---->
If you want to update the link text or switch it between image and link, just update the comment and rerun the CLI. You don't need to delete the rendered image or link.
Installation
npm i -g puml-for-markdown
Advanced Usage
Here are some other features supported
- You can specify the CLI to output the diagram images as png and/or svg see
--output-imagesand--image-formats. For an example of outputted images, checkout dist_puml/puml. These images were created by the pre-commit hook. - You can specify the PUML server used to render the diagrams see
--puml-server-url
All CLI Options
Usage: puml-for-markdown [options]
An application to add interactive PUML diagrams to your github markdown files. If running with default arguments, run in project root directory.
Options:
-s, --puml-server-url <url> This is the base URL used to render diagrams. Defaults to the public plantuml server. (default: "https://www.plantuml.com/plantuml")
-x, --root-directory <path> The path to your project (default: CWD)
-r, --hot-reload Rerun markdown generator every `interval` seconds, determined by interval option
-v, --interval-seconds <number> If --hot-reload is set, how often should it reload (default: 2)
-p, --puml-directory <path> Path to directory containing puml files which are referenced in markdown files (default: rootDirectory)
-m, --markdown-directory <path> Path to directory containing markdown files referencing puml files (default: rootDirectory)
-g, --ignore-gitignore Don't use .gitignore to skip PUML and MD
-i, --gitignore-path <path> Use this as path to .gitignore file. (default: rootDirectory/.gitignore)
-d, --output-images If set, will output images of diagrams to the dist directory
-b, --dist-directory <path> If --output-images is set, path to output diagram images (default: rootDirectory/dist_puml)
-f, --image-formats <format> If --output-images is set, sets the output image format (choices: "png", "svg", "both", default: "png")
-t, --turn-off-link-shortening Use the full puml server link instead of the tiny url, if your diagrams are too big this won't work
-h, --help display help for command
Notes
- Comments within inline or multiline code styling will be ignored
- Currently doesn't support cyclic graph references, i.e. a diagram can't reference any diagrams which reference back to it
- See the pre-commit hook to see how to add a git hook
- If you are saving diagram images and have puml files which only define constants or settings (i.e. example) you'll see a warning in the console saying it failed to save the image to file because these aren't renderable on their own (since there is nothing to render)
- Anything inside
inline codeorcode blockswill be excluded from rendering
How It Works
Using PlantUML Web Service to Render PUML Diagrams
You can use PlantUML using the online web service to generate images on-the-fly. A online demonstration is available at http://www.plantuml.com/plantuml. You can pass the encoded text of your diagrams to the web service in the url path and it will generate an SVG or PNG for you. Here's a simple HelloWorld example http://www.plantuml.com/plantuml/uml/Aov9B2hXil98pSd9LoZFByf9iUOgBial0000. Large diagrams will have very long encoding strings, they can exceed maximum url length. They also don't look very good in markdown files. By default the CLI will use the tinyurl.com service to shorten the link to the diagram.
Encoding PUML Diagrams for the Web Service
The CLI will use the plantuml-encoder package to encode puml files. To support hyperlinking diagrams we need to parse all hyperlinks in the puml files. A dependency graph is created for the files and a DFS is performed where we create links for the leaf nodes first, then replace the links in the parent nodes with the links to the leaf nodes. The puml files are not actually modified, only the puml files content in memory is modified. By default the tinyurl free service is used to shorten the links.
In order to support !include we parse puml files and replace any !include with the contents of the file referenced.
Parsing Markdown
The markdown files are then parsed for markdown comments. If the comments reference a PlantUML file, a link to the web service url will be added next to the comment. Because these links contain the full PlantUML diagram encoding in it, there are no issues using them in private repositories.
Testing
Currently there is no TDD, for now I've just been using the example diagrams to test. The examples are pretty extensive though.
Other Helpful Links
- C4-Puml: A collection of PlantUML diagrams for use in C4, you'll see me using this in my examples
80 Dec 21, 2022
26 Dec 8, 2022
13 Jan 2, 2023
4 Mar 16, 2023
7 Sep 13, 2022
24 Aug 22, 2022
20 Dec 17, 2022
652 Dec 30, 2022
12 Nov 8, 2022
12 Oct 10, 2022
20 Oct 30, 2022
43 Dec 20, 2022
91 Jan 2, 2023
25 Dec 20, 2022
7 Dec 13, 2022
96 Dec 27, 2022
7 Dec 31, 2022
474 Oct 8, 2022