[FEA] Add mermaid.js support
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- jekyll
- Domain
- build-system, documentation
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.
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
- Dominant language
- HTML
- Stars
- 52
- Forks
- 73
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 10
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from rapidsai/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
rapidsai/docs#818 · 1 comment ·
Maintainers usually reply within 1 day
-
? - Needs Triage doc
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
rapidsai/docs#673 · 1 comment ·
Maintainers usually reply within 1 day
-
feature request
Difficulty 4/5 3-5 days Newbie friendliness 45/100
rapidsai/docs#751 · 1 reaction ·
Maintainers usually reply within 1 day
-
? - Needs Triage feature request
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
Similar issues
-
enhancement
Difficulty 2/5 Under an hour Newbie friendliness 72/100
afarber/OpenMapView#22 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
rescript-lang/rescript#8765 ·
Maintainers usually reply within 1 day
-
[request] vsg/1.1.16Openupstream update
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
conan-io/conan-center-index#31142 ·
Maintainers usually reply within 1 day
-
bot-found documentation priority: P3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
madenvel/KalinkaPlayer#313 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day