1
0
mirror of synced 2025-12-22 19:34:15 -05:00
Files
docs/content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md
2022-02-14 17:06:40 +00:00

1.2 KiB

title, intro, versions, shortTitle
title intro versions shortTitle
Creating diagrams Create diagrams to convey information through charts and graphs
feature
mermaid
Create diagrams

You can use Mermaid syntax to create diagrams. Mermaid is a Markdown-inspired tool that renders text into diagrams. For example, Mermaid can render flow charts, sequence diagrams, pie charts and more. For more information, see the Mermaid documentation.

To create a Mermaid diagram, add Mermaid syntax inside a fenced code block with the mermaid language identifier. For more information about creating code blocks, see "Creating and highlighting code blocks."

For example, you can create a flow chart:

Here is a simple flow chart:

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

Rendered Mermaid flow chart

{% note %}

Note: You may observe errors if you run a third-party Mermaid plugin when using Mermaid syntax on {% data variables.product.company_short %}.

{% endnote %}