Skip to content

Commit

Permalink
Include reference to Mermaid Playground (#1796)
Browse files Browse the repository at this point in the history
  • Loading branch information
stevepiercy authored Nov 28, 2024
1 parent aea0b93 commit 551a63c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/contributing/documentation/myst-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,10 +273,13 @@ For an in depth discussion of privacy issues, see [How to embed YouTube videos w

You can use [Mermaid](https://mermaid.js.org/) and its Sphinx extension [`sphinxcontrib.mermaid`](https://pypi.org/project/sphinxcontrib-mermaid/) to render graphs in your documents, including general flowcharts, sequence diagrams, and Gantt charts.

You can use the [Mermaid Playground](https://www.mermaidchart.com/play) to compose Mermaid markup and preview a live diagram.

````{example}
```{mermaid}
:alt: Mental model of Plone
:caption: Mental model of Plone
:zoom:
block-beta
columns 4
Plone["Plone<br/>integraton of all in one release"]:4
Expand Down

0 comments on commit 551a63c

Please sign in to comment.