From 1136834d63cc7a007ccdbafd92dbd6b0d76f50a3 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 22 Jan 2021 00:11:58 -0800 Subject: [PATCH] Update README.md --- docs/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index 3846dbda0..daec315ab 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ **Mermaid lets you create diagrams using text and code.** This simplifies the maintenance of complex diagrams. It is a Javascript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically. -If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](./n00b-syntaxReference.md). +>If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](./n00b-syntaxReference.md). ![banner](img/header.png) @@ -176,12 +176,10 @@ To select a version: Replace `` with the desired version number. -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/) ## Deploying Mermaid -To support mermaid on your website, all you have to do is add Mermaid’s JavaScript package +To Deploy Mermaid: ``` 1.You will need to install node v10 or 12, which would have npm @@ -195,13 +193,15 @@ To support mermaid on your website, all you have to do is add Mermaid’s JavaSc yarn add --dev mermaid ``` +## [Mermaid API](./Setup.md): **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"`. From these tags mermaid will try to read the diagram/chart definitons and render them into svg charts.** **Examples can be found in** [Other examples](/examples)