[FEA] Add mermaid.js support
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 52
- Forks
- 73
- Avg merge
- 4d 16m
- Merged PRs (30d)
- 8
Description
Describe the solution you'd like
I want to be able to write Mermaid diagrams in our docs, similar to what we can do in Github.
@jameslamb found this guide, which seems simple enough, but I don't know if there are hidden dragons. https://stuff-things.net/2025/01/19/mermaid-diagramming-in-jekyll-in-2025/
Describe alternatives you've considered
Static images of diagrams created elsewhere. This is viable, but the perk of mermaid diagrams is that the source code of the diagram lives in the docs and can be fixed or improved in the future.
Additional context
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked guide on Mermaid diagrams in Jekyll and inspecting this repository's documentation rendering and build configuration. Done means Mermaid source can be written in the docs and renders as diagrams without breaking the existing documentation build.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jekyll
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100