Skip to content

Commit 8287ee7

Browse files
matt-manuelshiranr
andauthored
Matt manuel/865 language mermaid update (microsoft#866)
* Added example mermaid diagram Added code and an image of an example Mermaid diagram. Updated link for the Mermaid Live Editor. * small fix to capitalization of PNG -> png To be consistent with the rest of the text the reference to a PNG file is changed to png * Adding source Mermaid file for png diagram Forgot to add a source file for the example Mermaid diagam. Co-authored-by: Shiran Rubin <[email protected]>
1 parent 2184237 commit 8287ee7

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
graph LR
2+
A[Diagram Idea] -->|Write mermaid code| B(mermaid.mmd file)
3+
B -->|Add to source control| C{Code repo}
4+
B -->|Export as .png| G(.png file of diagram)
5+
G -->|Add to source control| C
Loading

docs/documentation/tools/languages.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,28 @@ Mermaid lets you create diagrams using text definitions that can later be render
2525

2626
Mermaid files (.mmd) can be source-controlled along with your code. It's also recommended to include image files (.png) with the rendered diagrams under source control. Your markdown files should link the image files, so they can be read without the need of a Mermaid rendering tool (e.g., during Pull Request review).
2727

28+
### Example Mermaid diagram
29+
30+
This is an example of a Mermaid flowchart diagram written as code.
31+
32+
```mermaid
33+
graph LR
34+
A[Diagram Idea] -->|Write mermaid code| B(mermaid.mmd file)
35+
B -->|Add to source control| C{Code repo}
36+
B -->|Export as .png| G(.png file of diagram)
37+
G -->|Add to source control| C
38+
```
39+
40+
This is an example of how it can be rendered as an image.
41+
42+
![Example mermaid diagram](images/example-mermaid-diagram.png "Example mermaid diagram")
43+
2844
More information:
2945

3046
- [About Mermaid](https://mermaid-js.github.io/mermaid/#/)
3147
- [Diagram syntax](https://mermaid-js.github.io/mermaid/#/./n00b-syntaxReference)
3248

3349
Tools:
3450

35-
- [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor)
51+
- [Mermaid Live Editor](https://mermaid.live)
3652
- [Markdown Preview Mermaid Support for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid)

0 commit comments

Comments
 (0)