diff --git a/README.md b/README.md index 4451bef6d..c759ebed2 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,12 @@ Mermaid addresses this problem by cutting the time, effort and tooling that is r The text definitions for Mermaid diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code). So less time needs be spent on documenting, as a separate and laborious task.
Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor).
-[Tutorials](./docs/getting-started/Tutorials.md) has video tutorials. -Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/overview/integrations.md). +[Tutorials](./docs/Tutorials.md) has video tutorials. +Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/integrations.md). -For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/overview/n00b-overview.md) and [Usage](./docs/getting-started/usage.md). +For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/n00b-overview.md) and [Usage](./docs/usage.md). -🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) | πŸ“œ [Changelog](./docs/tutorials-and-community/CHANGELOG.md) +🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) | πŸ“œ [Changelog](./docs/CHANGELOG.md) diff --git a/docs/README.md b/docs/README.md index 08074e170..babbe9ae3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -23,13 +23,13 @@ With Mermaid less time needs to be spent on making diagrams, as a separate docum > Mermaid is a Diagramming tool for everyone. -Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor), Visit the [Tutorials Page](https://github.com/mermaid-js/mermaid/blob/develop/docs/getting-started/Tutorials.md) for the Live Editor video tutorials. +Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor), Visit the [Tutorials Page](https://github.com/mermaid-js/mermaid/blob/develop/docs/Tutorials.md) for the Live Editor video tutorials. -Want to see what can be built with mermaid, or what applications already support it? Read the [Integrations and Usages for Mermaid](overview/integrations.md). +Want to see what can be built with mermaid, or what applications already support it? Read the [Integrations and Usages for Mermaid](./integrations.md). -For a more detailed introduction to Mermaid and some of it's more basic uses, look to the [Beginner's Guide](overview/n00b-overview.md) and [Usage](getting-started/usage.md). +For a more detailed introduction to Mermaid and some of it's more basic uses, look to the [Beginner's Guide](./n00b-overview.md) and [Usage](./usage.md). -🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/docs/tutorials-and-community/development.md) | πŸ“œ [Version Log](tutorials-and-community/CHANGELOG.md) +🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/docs/development.md) | πŸ“œ [Version Log](./CHANGELOG.md) > πŸ–– Keep a steady pulse: mermaid needs more Collaborators, [Read More](https://github.com/knsv/mermaid/issues/866). @@ -154,9 +154,10 @@ journey ![Journey diagram](img/user-journey.png) # 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](./n00b-gettingStarted.md) and [Usage](./usage.md).** + +**It would also be helpful to learn more about mermaid's [Syntax](./n00b-syntaxReference.md).** ### CDN @@ -172,7 +173,7 @@ Alternatively, you can also adjust the version number in the page itself. Latest Version: [https://unpkg.com/browse/mermaid@8.8.0/](https://unpkg.com/browse/mermaid@8.8.0/) -## Incorporating mermaid to a website +## Mermaid on a website To support mermaid on your website, all you have to do is add Mermaid’s JavaScript package ``` @@ -188,14 +189,14 @@ To support mermaid on your website, all you have to do is add Mermaid’s JavaSc ``` -## To deploy mermaid without a bundler, one can insert a `script` tag with an absolute address and a `mermaidAPI` call into the HTML like so: +**To deploy mermaid without a bundler, one can insert a `script` tag with an absolute address and a `mermaidAPI` call into the HTML like so:** ```html ``` -## Doing so will command the mermaid parser to look for the `
` 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 `
` 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](./n00b-gettingStarted.md) # Sibling projects - [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor) diff --git a/docs/flowchart.md b/docs/flowchart.md index 85b76de2d..658f9c4bc 100644 --- a/docs/flowchart.md +++ b/docs/flowchart.md @@ -161,18 +161,14 @@ graph LR ``` ### A hexagon node -{% raw %} ``` graph LR id1{{This is the text in the box}} ``` -{% endraw %} ```mermaid -{% raw %} graph LR id1{{This is the text in the box}} -{% endraw %} ``` ### Parallelogram diff --git a/docs/index.html b/docs/index.html index 2814a046a..0e39d5f5e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,7 +7,7 @@ - +