Skip to content

# Feature Request: Mermaid Diagram Support in Rich Markdown Content #401

Description

@neerajlovecyber

Summary

Add support for rendering Mermaid diagrams inside Rich Markdown content.

Problem

Many technical documentation sites and knowledge bases rely on Mermaid diagrams to visualize workflows, architectures, sequences, entity relationships, and other concepts directly within Markdown files.

Currently, Mermaid code blocks are displayed as plain text, requiring users to either:

  • Use external image generation tools.
  • Embed screenshots of diagrams.
  • Switch to alternative documentation platforms that support Mermaid natively.

This reduces the usefulness of Rich Markdown for technical documentation.

Proposed Solution

Add built-in Mermaid rendering for fenced code blocks with the mermaid language identifier.

Example:

```mermaid
graph TD
    A[User] --> B[PageCMS]
    B --> C[Database]
```

Should render as an interactive Mermaid diagram instead of a code block.

Benefits

  • Better technical documentation experience.

  • Reduced need for external diagram images.

  • Keeps documentation version-controlled and text-based.

  • Supports common diagram types:

    • Flowcharts
    • Sequence diagrams
    • Class diagrams
    • ER diagrams
    • State diagrams
    • User journey diagrams
    • Gantt charts

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions