GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-14 06:43:25 +08:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Neil Cuzon 2020-07-15 14:11:35 -07:00 committed by GitHub
parent dcfab0f4dd
commit 789200d454
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/README.md
View File

@ -30,6 +30,8 @@ You can also watch some popular mermaid tutorials.
## [Documentation](https://mermaidjs.github.io) ## [Documentation](https://mermaidjs.github.io)
## [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md)
# New in Version 8.6.0 # New in Version 8.6.0
@ -216,12 +218,14 @@ to support mermaid on your website, all you have to do is add Mermaid’s JavaSc
``` ```
1.You will need to isntall node v10 or 12, which would have npm 1.You will need to isntall node v10 or 12, which would have npm
2. download yarn using npm 2. download yarn using npm.
2. yarn add mermaid 2. enter the following command:
yarn add mermaid
3. yarn add --dev mermaid 3. You can then add mermaid as a dev dependency using this command:
this will add mermaid as a dev dependency yarn add --dev mermaid
``` ```
## To install mermaid without a bundler, one can use the script tag like so: ## To install mermaid without a bundler, one can use the script tag like so:
@ -230,9 +234,7 @@ to support mermaid on your website, all you have to do is add Mermaid’s JavaSc
<script>mermaid.initialize({startOnLoad:true});</script> <script>mermaid.initialize({startOnLoad:true});</script>
## it can then be followed by the diagram definitions as could be found in the examples in the documentation. ## it can then be followed by the diagram definitions as could be found in the examples in the documentation.
## Further down on your page mermaid will look for tags with class="mermaid". From these tags mermaid will try to read the chart definiton and replace it with an svg chart.
## the renderer will then scour the document for all the objects defined as mermaid. which will then be rendered as an SVG file.
## Sibling projects ## Sibling projects
- [mermaid live editor](https://github.com/mermaidjs/mermaid-live-editor) - [mermaid live editor](https://github.com/mermaidjs/mermaid-live-editor)