From 4fb40a6af7248e570f7f10f5970311326c5c0107 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 24 Jul 2020 22:51:27 -0700 Subject: [PATCH] Update usage.md --- docs/usage.md | 68 +++++++++++++++++++-------------------------------- 1 file changed, 25 insertions(+), 43 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index 58e5862c4..4359aeb02 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -5,13 +5,17 @@ mermaid is a javascript tool that makes use of a markdown based syntax to render mermaid was made to 0help Documentation catch up with Development, in quickly changing projects. +### CDN + +https://unpkg.com/mermaid/ + +Please note that you can switch versions through the dropdown box at the top right. + ## Using mermaid For the majority of beginners, using the live editor or suppoting mermaid on a webpage would cover their uses for mermaid. -**To learn how to use [Getting Started](https://mermaid-js.github.io/mermaid/#/n00b-gettingStarted).** - -## Installation +## Installing and Hosting mermaid on a webpage ### Using the npm package @@ -26,57 +30,34 @@ For the majority of beginners, using the live editor or suppoting mermaid on a w 4. At this point, you can add mermaid as a dev dependency using this command: yarn add --dev mermaid -5. alternatively, you can deploy it using the script tag in an HTML file with mermaid diagram descriptions. This is explored in greater depth in the [User Guide for Beginners](./n00b-gettingStarted.md) - +5. alternatively, you can deploy it using the script tag in an HTML file with mermaid diagram descriptions. ``` +For -### CDN +## Hosting mermaid on a web page. -https://unpkg.com/mermaid/ - -Please note that you can switch versions through the dropdown box at the top right. - - -## Simple usage on a web page +**Notes**: This topic explored in greater depth in the [User Guide for Beginners](./n00b-gettingStarted.md) The easiest way to integrate mermaid on a web page requires two elements: 1. Inclusion of the mermaid address in the html page using a `script` tag, in the `src` section. -2. A graph definition, inside `