marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-10-10 17:49:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Neil Cuzon
2020-10-30 17:57:36 -07:00
committed by GitHub
parent 56fbbef133
commit aba8c0356a
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/README.md
View File

@@ -154,9 +154,10 @@ journey
![Journey diagram](img/user-journey.png) ![Journey diagram](img/user-journey.png)
# Installation # Installation
## In depth guides and examples can be found in [Getting Started](getting-started/n00b-gettingStarted.md) and [Usage](getting-started/usage.md).
## It would also be helpful to learn more about mermaid's [Syntax](diagrams-and-syntax-and-examples/n00b-syntaxReference.md). **In depth guides and examples can be found in [Getting Started](docs/n00b-gettingStarted.md) and [Usage](docs/usage.md).**
**It would also be helpful to learn more about mermaid's [Syntax](docs/n00b-syntaxReference.md).**
### CDN ### CDN
@@ -195,7 +196,7 @@ To support mermaid on your website, all you have to do is add Mermaid’s JavaSc
``` ```
## Doing so will command the mermaid parser to look for the `<div>` tags with `class="mermaid"` in your HTML Document. From these tags mermaid will try to read the diagram/chart definitons and render them as svg charts. ## Doing so will command the mermaid parser to look for the `<div>` tags with `class="mermaid"` in your HTML Document. From these tags mermaid will try to read the diagram/chart definitons and render them as svg charts.
## Examples can be found in [Getting Started](getting-started/n00b-gettingStarted.md) ## Examples can be found in [Getting Started](docs/n00b-gettingStarted.md)
# Sibling projects # Sibling projects
- [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor) - [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor)