Skip to content

Add docs for creating diagrams in markdown files #3098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arthurwolf merged 1 commit into from
Mar 14, 2023
Merged

Add docs for creating diagrams in markdown files #3098

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/diagrams/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,26 @@ This is a "diagrams playground" folder and you don't have to use this. Instead,
B->>-A: Greetings!
```

To create diagrams in a markdown file, you can use the same syntax as above but wrap it in triple backticks (used for code blocks) with `{eval-rst}` as the language identifier, e.g.:

````markdown
```{eval-rst}
.. kroki::
:type: mermaid
:caption: Diagram

%% The message sending flow as implemented for M1 (Oct 2021) federation
sequenceDiagram
actor A as Alice
participant B as Backend

Note over A,B: send message
%% this is a code-comment not visible
A->>+B: Hello!
B->>-A: Greetings!!!!
```
````

For more information, see syntax on https://mermaid-js.github.io/mermaid/#/sequenceDiagram

# Playground mermaid setup and further links
Expand Down