Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Makefile recipe for generating PNGs from Mermaid diagrams #42

Closed
agrski opened this issue Jan 25, 2024 · 0 comments · Fixed by #43
Closed

Add Makefile recipe for generating PNGs from Mermaid diagrams #42

agrski opened this issue Jan 25, 2024 · 0 comments · Fixed by #43
Assignees

Comments

@agrski
Copy link
Owner

agrski commented Jan 25, 2024

It's easy to forget to generate (up to date) diagrams from Mermaid definitions, especially when there are multiple diagrams per post. This is complicated by the process of adding copyright notices to the generated diagrams using an additional process, as Mermaid does not (yet) support adding captions to all its diagrams formats.

Writing a Makefile recipe would automate this process by capturing the required steps and, if written appropriately, would ensure all diagrams which are out of date relative to their definitions are automatically regenerated when the recipe is run.

In turn, this would support a GitHub Action to detect (or even automatically fix) the issue of stale images for diagrams. This additional functionality would be deferred to another issue, but is mentioned for completeness of context and motivation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant