Skip to content

[Enhancement]: Add mermaid for diagrams #492

@JC-DSIT

Description

@JC-DSIT

What should change?

There is a suggestion to add in mermaid support in PR #184

This makes sense as mermaid is a well known, well supported markdown tool for generating diagrams. They are customisable, and have some configuration available for accessibility.

User need

People are already using it, but they are manually writing html into the markdown rather than using a pure markdown solution.

Proposed solution

Run a couple of experiments with

  • the mermaid gem
  • -mermaid npm package
  • just having mermaid natively available

See how they work and which is easiest for non-technical people to use

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request
    No fields configured for Feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions