Skip to content

README Md feature: Mermaid diagrams #338

Open
Open
README Md feature: Mermaid diagrams#338

Description

@tengssh
tengssh
opened on Apr 27, 2026

I want to share another README feature: Mermaid syntax.
It can create simple flowcharts using just text.

For example:

graph LR
    A["Prompt"] --> B["Chat"] --> D["Review"]
    A --> C["IDE"] --> D
Loading

Thank you!

Activity

  1. bast commented on Apr 27, 2026

    @bast
    bast
    on Apr 27, 2026
    Member

    Thank you!

  2. mmesiti commented on Apr 30, 2026

    @mmesiti
    mmesiti
    on Apr 30, 2026
    Contributor

    This is cool, I have seen it before.
    I would like to check first how supported this is on other services that are not GitHub...

  3. mmesiti
    changed the title [-]Share one README feature[/-] [+]README Md feature: Mermaid diagrams[/+] on Apr 30, 2026

  4. mmesiti commented on Oct 29, 2026

    @mmesiti
    mmesiti
    on Oct 29, 2026
    Contributor

    I'm using it now and I think that it's worth adding. Although: getting diagrams exactly the way one wants is a bit cumbersome, like with graphviz. Does anyone have experience with this, for some practical advice?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions