spring-projects / spring-projects/spring-modulith
Support generating markdown with mermaid
Open
Nobody has claimed this yet.
in: documentation support
type: enhancement
- Dominant language
- Java
- Stars
- 1.2k
- Forks
- 222
- PR merge metrics
- No merged PRs in 30d
Description
Github supports rendering Mermaid (an alternative to plantuml) in its markdown (no idea on asciidoc). So does microsofts azure thing. It would be nice to have support for emitting markdown with this.
Feels like a nice to have built in.
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 locating the existing PlantUML and markdown-generation paths in the repository, then determine where Mermaid output would fit. Compare the generated markdown with GitHub's Mermaid rendering behavior and define completion as supported Mermaid diagrams being emitted correctly, with the relevant generation behavior covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, markdown, spring-boot
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100