🚀 ADR: Support for MermaidJS diagrams

[dylanjustice]

Plugin Name

adr

🔖 Feature description

Support mermaidjs diagram rendering from code fences in ADRs.

🎤 Context

Allow teams to include diagrams, architectural or flow, to help illustrate proposed changes or implementation details of their ADRs. Examples could include;

• Logical Flow Diagrams
• Class diagrams (C4)
• Architectural diagrams

✌️ Possible Implementation

Create a custom marked extension to pick up code fence tokens indicating mermaid as the language type.
Marked Code Preview and Marked JSX Renderer are pretty close to what I'm thinking, but for mermaid.

parseMadrWithFrontmatter would implement the extension when parsing, marked.use(mermaidExtension).

Not sure what the implementation would look like, but a nice way to make the plugin more extensible would be to allow consumers of the plugin to provide their own extensions through the <EntityAdrContent /> component or register them in the adr-backend.

👀 Have you spent some time to check if this feature request has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Are you willing to submit PR?

Yes I am willing to submit a PR!

[dylanjustice]

Looking at this again. Could this be done with a custom content decorator?

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.