-
Notifications
You must be signed in to change notification settings - Fork 12
Create mermaid.md #15
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Mermaid Overview | ||
|
|
||
| ## What is Mermaid? | ||
|
|
||
| Mermaid is a flowchart and diagram visualization tool based on JavaScript and uses Markdown syntax to create flowcharts that are extremely dynamic and high quality. Mermaid is especially useful because you are able to display your beautiful flowcharts using backticks to create a code block. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can you link to the docs?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you mean linking to repo? https://github.com/mermaid-js/mermaid/tree/develop/docs or our docs?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the rendered website of the mermaid documentation |
||
|
|
||
| ## Tutorial for Using Mermaid | ||
|
|
||
| Either on the [Mermaid](https://mermaid.live/edit#pako:eNpVjstqw0AMRX9FaNVC_ANeFBq7zSbQQrPzZCFsOTMk80CWCcH2v3ccb1qtxD3nCk3Yxo6xxP4W760lUTjVJkCe96ay4gb1NJyhKN7mAyv4GPgxw_7lEGGwMSUXLq-bv18lqKbjqjGodeG6bKh69r8Cz1A3R0oa0_kvOd3jDB-N-7b5_H9ihXPrs-mp7KloSaAieSq4Q8_iyXX5_WlNDKplzwbLvHYkV4MmLNmjUePPI7RYqoy8wzF1pFw7ugj5LVx-AfLqVWg) website or in the file you're making edits to you can make complex flowcharts seamlessly. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this link is to a specific diagram, can you make it clean? |
||
|
|
||
| ### Using Code Blocks | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is github specific, can you make that clear. |
||
|
|
||
| A code block should look like the following: | ||
| ```` | ||
| ```mermaid | ||
| blah blah blah | ||
| ``` | ||
| ```` | ||
|
|
||
| ### Example Mermaid Code Block | ||
|
|
||
| ```mermaid | ||
| flowchart TD | ||
| A[Christmas] -->|Get money| B(Go shopping) | ||
| B --> C{Let me think} | ||
| C -->|One| D[Laptop] | ||
| C -->|Two| E[iPhone] | ||
| C -->|Three| F[fa:fa-car Car] | ||
| ``` | ||
|
Comment on lines
+22
to
+29
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this renders in GitHub, but will not render on the course website.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should I link an image instead?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No it can render on the website, but the syntax is not quite right. See the examples in the course website to find the right syntax. |
||
|
|
||
| In Mermaid there are different styles for boxes with either square or round edges and the option to give a description of each item in its pipe. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. link to docs here |
||
|
|
||
| So the code above actually looks like this in it's code block: | ||
|
|
||
| ```` | ||
| ```mermaid | ||
| flowchart TD | ||
| A[Christmas] -->|Get money| B(Go shopping) | ||
| B --> C{Let me think} | ||
| C -->|One| D[Laptop] | ||
| C -->|Two| E[iPhone] | ||
| C -->|Three| F[fa:fa-car Car] | ||
| ``` | ||
| ```` | ||
|
|
||
| There's lots of cool and unique things that can be created using Mermaid and the best way to understand it better is to continue to practice. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
putting this in the "syllabus" folder does not really make sense