Investigate mermaid plugin
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 88
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
Mermaid is useful to create diagrams and schemas. We already
use it on some of our docs but it is a bit tedious to write
the diagram code in the editor, save the image, move the image
to the git repo, and link it. Additionally, if we forget to
update the image, it can be desynced.
This plugin could help with writing and maintaining easily
mermaid diagrams in our docs by using the mermaid javascript
library to render the diagram from source on the client.
See https://github.com/fralau/mkdocs-mermaid2-plugin#general-principle
What do you think ? Is anybody interested in testing it ?
Contributor guide
No contributing guide indexed for this repository
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 mkdocs-mermaid2-plugin description and reviewing the existing documentation diagrams. Determine whether client-side Mermaid rendering fits this site and how it could replace manually generated images. Done means producing a tested integration proposal or implementation decision, including how diagram source and rendered output would be maintained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100