Mermaid: Difference between revisions

From air
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 3: Line 3:
Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code?
Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code?


Exemple : http://knsv.github.io/mermaid/live_editor/
Exemples : https://knsv.github.io/mermaid/#working-with-the-documentation



Exemple de Gantt chart
Editer d'exemple de l'exemple Gantt chart avec http://knsv.github.io/mermaid/live_editor/
<pre>
<pre>


Line 24: Line 25:
Add to mermaid :1d
Add to mermaid :1d


</pre>

En ligne de commande
<pre>

$ npm install phantomjs

$ npm install -g mermaid

$ mermaid --help

Usage: mermaid [options] ...

file The mermaid description file to be rendered

Options:
-s --svg Output SVG instead of PNG (experimental)
-p --png If SVG was selected, and you also want PNG, set this flag
-o --outputDir Directory to save files, will be created automatically, defaults to `cwd`
-e --phantomPath Specify the path to the phantomjs executable
-c --sequenceConfig Specify the path to the file with the configuration to be applied in the sequence diagram
-h --help Show this message
-v --verbose Show logging
-w --width width of the generated png (number)
--version Print version and quit

$ mermaid -e ~/node_modules/phantomjs/lib/phantom/bin/phantomjs gantt.mmd

$ mermaid -e ~/node_modules/phantomjs/lib/phantom/bin/phantomjs --svg gantt.mmd
</pre>
</pre>

Latest revision as of 14:42, 31 December 2016

https://knsv.github.io/mermaid/#mermaid

Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code?

Exemples : https://knsv.github.io/mermaid/#working-with-the-documentation


Editer d'exemple de l'exemple Gantt chart avec http://knsv.github.io/mermaid/live_editor/


gantt
        dateFormat  YYYY-MM-DD
        title Adding GANTT diagram functionality to mermaid
        section A section
        Completed task            :done,    des1, 2014-01-06,2014-01-08
        Active task               :active,  des2, 2014-01-09, 3d
        Future task               :         des3, after des2, 5d
        Future task2               :         des4, after des3, 5d
        section Critical tasks
        Completed task in the critical line :crit, done, 2014-01-06,24h
        Implement parser and jison          :crit, done, after des1, 2d
        Create tests for parser             :crit, active, 3d
        Future task in critical line        :crit, 5d
        Create tests for renderer           :2d
        Add to mermaid                      :1d

En ligne de commande


$ npm install phantomjs

$ npm install -g mermaid

$ mermaid --help

Usage: mermaid [options] ...

file    The mermaid description file to be rendered

Options:
  -s --svg             Output SVG instead of PNG (experimental)
  -p --png             If SVG was selected, and you also want PNG, set this flag
  -o --outputDir       Directory to save files, will be created automatically, defaults to `cwd`
  -e --phantomPath     Specify the path to the phantomjs executable
  -c --sequenceConfig  Specify the path to the file with the configuration to be applied in the sequence diagram
  -h --help            Show this message
  -v --verbose         Show logging
  -w --width           width of the generated png (number)
  --version            Print version and quit

$ mermaid -e ~/node_modules/phantomjs/lib/phantom/bin/phantomjs gantt.mmd

$ mermaid -e ~/node_modules/phantomjs/lib/phantom/bin/phantomjs --svg gantt.mmd