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

Merge pull request #406 from jinntrance/master

Browse Source 
update usage and fix #273
This commit is contained in:
Knut Sveidqvist
2016-11-06 22:42:10 +01:00
committed by GitHub
parent fa91653beb aa93860466
commit e8f28b71f7
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/content/usage.md
View File

@@ -15,15 +15,17 @@ bower install mermaid --save-dev
npm install mermaid --save-dev npm install mermaid --save-dev
``` ```
Or download javascript files as per the url below, note that #version# should be replaced with version of choice: Or download css and javascript files as per the url below, note that #version# should be replaced with version of choice:
``` ```
https://cdn.rawgit.com/knsv/mermaid/#version#/dist/mermaid.css
https://cdn.rawgit.com/knsv/mermaid/#version#/dist/mermaid.min.js https://cdn.rawgit.com/knsv/mermaid/#version#/dist/mermaid.min.js
``` ```
Ex: Ex:
* [version 0.5.1](https://cdn.rawgit.com/knsv/mermaid/0.5.1/dist/mermaid.min.js) * [js version 6.0.0](https://cdn.rawgit.com/knsv/mermaid/6.0.0/dist/mermaid.min.js)
Checkout the [latest version](https://github.com/knsv/mermaid/releases) and [other styles](https://github.com/knsv/mermaid/tree/master/dist) such as `forest` and `dark`.
There are some bundles to choose from: There are some bundles to choose from:
* mermaid.js, mermaid.min.js This bundle contains everything you need to run mermaid * mermaid.js, mermaid.min.js This bundle contains everything you need to run mermaid
@@ -47,10 +49,10 @@ locate the graphs n the page and transform them to svg files.
### Include mermaid on your web page: ### Include mermaid on your web page:
``` ```html
<link rel="stylesheet" href="mermaid.css">
&lt;script src=&quot;mermaid.min.js&quot;&gt;&lt;/script&gt; &lt;script src=&quot;mermaid.min.js&quot;&gt;&lt;/script&gt;
&lt;script&gt;mermaid.initialize({startOnLoad:true});&lt;/script&gt; &lt;script&gt;mermaid.initialize({startOnLoad:true});&lt;/script&gt;
``` ```
Further down on your page mermaid will look for tags with ```class="mermaid"```. From these tags mermaid will try to Further down on your page mermaid will look for tags with ```class="mermaid"```. From these tags mermaid will try to