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

Fix links in documentations

Browse Source 
* The main change (in term of importance) is the fix of two broken links that were
pointing to outdated sections ids.
* Added a link to mermaidCLI in the sequenceDiagram section, to reflect the one in
the gantt section.

* Converted some links to https.
This commit is contained in:
Antoine Bolvy
2017-03-23 20:17:01 -04:00
parent 96be32225e
commit b50c15e278
3 changed files with 32 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/content/index.md
View File

@@ -4,15 +4,13 @@ order: 0
mermaid
=======
![Alt text](images/header.png)
![Header Image](images/header.png)
>Generation of diagrams and flowcharts from text in a similar manner as markdown.
Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code?
This is why mermaid was born, a simple markdown-like script language for generating charts from text via javascript. [Try it using our editor](http://knsv.github.io/mermaid/live_editor).
This is why mermaid was born, a simple markdown-like script language for generating charts from text via javascript. [Try it using our editor][live_editor].
Code examples below:
@@ -59,13 +57,11 @@ gantt
Add to mermaid :1d
```
Play with mermaid using this [editor](http://danielmschmidt.github.io/mermaid-demo/) or this [live editor](live_editor).
Play with mermaid using this [editor](https://danielmschmidt.github.io/mermaid-demo/) or this [live editor][live_editor].
## Credits
Many thanks to the [d3](http://d3js.org/) and [dagre-d3](https://github.com/cpettitt/dagre-d3) projects for providing
the graphical layout and drawing libraries! Thanks also to the
[js-sequence-diagram](http://bramp.github.io/js-sequence-diagrams) project for usage of the grammar for the
sequence diagrams.
Many thanks to the [d3](https://d3js.org/) and [dagre-d3](https://github.com/cpettitt/dagre-d3) projects for providing the graphical layout and drawing libraries!
Thanks also to the [js-sequence-diagram](https://bramp.github.io/js-sequence-diagrams) project for usage of the grammar for the sequence diagrams.
*Mermaid was created by Knut Sveidqvist for easier documentation.*
@@ -84,7 +80,7 @@ Mermaid is supported in a number of publishing systems and editors. Please repor
* [Using mermaid via Octopress](http://mostlyblather.com/blog/2015/05/23/mermaid-jekyll-octopress/)
* [Mardown editor Haroopad](http://pad.haroopress.com/user.html)
* [Plugin for atom](https://atom.io/packages/atom-mermaid)
* [Markdown Plus](http://mdp.tylingsoft.com/)
* [Markdown Plus](https://mdp.tylingsoft.com/)
* [Vim Plugin](https://github.com/kannokanno/previm)
* [Sphinx extension](https://github.com/mgaitan/sphinxcontrib-mermaid)
* [Pandoc filter](https://github.com/raghur/mermaid-filter)
@@ -98,4 +94,6 @@ An editor is available for creating diagrams. With it you can quickly start writ
* get a link to a viewer of the diagram
* get a link to edit of the diagram to share a diagram so that someone else can tweak it and send a new link back
* [Editor](http://knsv.github.io/mermaid/live_editor)
* [Editor][live_editor]
[live_editor]: https://knsv.github.io/mermaid/live_editor/