diff --git a/docs/img/Code-Preview-Config.png b/docs/img/Code-Preview-Config.png index 0f5354be0..5e8e696ce 100644 Binary files a/docs/img/Code-Preview-Config.png and b/docs/img/Code-Preview-Config.png differ diff --git a/docs/img/Configuration.png b/docs/img/Configuration.png index cff05709c..450c4733e 100644 Binary files a/docs/img/Configuration.png and b/docs/img/Configuration.png differ diff --git a/docs/img/DiagramDefinition.png b/docs/img/DiagramDefinition.png deleted file mode 100644 index 52bcd2163..000000000 Binary files a/docs/img/DiagramDefinition.png and /dev/null differ diff --git a/docs/img/DownloadChoices.png b/docs/img/DownloadChoices.png deleted file mode 100644 index b26cac8cb..000000000 Binary files a/docs/img/DownloadChoices.png and /dev/null differ diff --git a/docs/img/Live-Editor-Choices.png b/docs/img/Live-Editor-Choices.png index 80f043783..40bea1364 100644 Binary files a/docs/img/Live-Editor-Choices.png and b/docs/img/Live-Editor-Choices.png differ diff --git a/docs/n00b-gettingStarted.md b/docs/n00b-gettingStarted.md index 92f50f0ea..528654b43 100644 --- a/docs/n00b-gettingStarted.md +++ b/docs/n00b-gettingStarted.md @@ -1,43 +1,59 @@ # A Mermaid User-Guide for Beginners -Mermaid is composed of three parts, Deployment, Syntax and Configuration. -This section talks about the different ways to deploy Mermaid. Learning the [Syntax](./n00b-syntaxReference.md) ahead of time would be more helpful to the beginner. +Mermaid is composed of three parts, Deployment, Syntax and Configuration. ->Generally the live editor is enough for most general uses of mermaid, and is a good place to start learning. +This section talks about the different ways to deploy Mermaid. Learning the [Syntax](./n00b-syntaxReference.md) ahead of time would be more helpful to the beginner. + +> Generally the live editor is enough for most general uses of mermaid, and is a good place to start learning. **Absolute beginners are recommended to view the Video [Tutorials](./Tutorials.md) on the Live Editor, to gain a better understanding of mermaid.** ## Four ways of using mermaid: -1. Using the mermaid [Live Editor](https://mermaid-js.github.io/mermaid-live-editor/). + +1. Using the mermaid [Live Editor](https://mermaid-js.github.io/mermaid-live-editor/). 2. Using [mermaid plugins](./integrations.md) with programs you are familiar with. 3. Calling the Mermaid Javascript API. 4. Deploying Mermaid as a dependency. **Note: It is our recommendation that you review all approaches, and choose the one that is best for your project.** ->More in depth information can be found on [Usage](./usage.md). +> More in depth information can be found on [Usage](./usage.md). -## 1. Using [The Live Editor](https://mermaidjs.github.io/mermaid-live-editor). +## 1. Using [The Live Editor](https://mermaidjs.github.io/mermaid-live-editor/edit). - + -In the `Code` section one can write or edit raw mermaid code, and instantly `Preview` the rendered result on the panel beside it. +In the `Code` section one can write or edit raw mermaid code, and instantly `Preview` the rendered result on the panel beside it. The `Configuration` Section is for changing the appearance and behavior of mermaid diagrams. An easy introduction to mermaid configuration is found in the [Advanced usage](./n00b-advanced.md) section. A complete configuration reference cataloguing default values is found on the [mermaidAPI](Setup.md) page. -  +### Editing History + +Your code will be autosaved every minute into the Timeline tab of History, having the most recent 30 items. + +You can also manually save code by clicking the Save icon in History section which can be accessed in the Saved tab. This is stored only in the browser storage. + ### Saving a Diagram: -You may choose any of the methods below, to save it + +You may choose any of the methods below, to save it **We recommend that you save your diagram code on top of any method you choose, in order to make edits and modifications further down the line.**  ### Editing your diagrams -Editing is as easy as pasting your **Diagram code**, into the `code` section of the `Live Editor`. +Editing is as easy as pasting your **Diagram code**, into the `code` section of the `Live Editor`. + +### Loading from Gists + +The Gist you create should have a code.mmd file and optionally a config.json. [Example](https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a) + +To load a gist into the Editor, you can use https://mermaid-js.github.io/mermaid-live-editor/edit?gist=https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a + +and to View, https://mermaid-js.github.io/mermaid-live-editor/view?gist=https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a ## 2. Using Mermaid Plugins: @@ -51,10 +67,9 @@ This method can be used with any common web server. Apache, IIS, nginx, node exp You will also need a text editting tool like Notepad++, to generate an html file. It is then deployed by a web browser (such as Firefox, Chrome, Safari, but not Internet Explorer). -The API works by pulling rendering instructions from a source from `mermaid.js` to render diagrams in the page. +The API works by pulling rendering instructions from a source from `mermaid.js` to render diagrams in the page. - -### Requirements for the Mermaid API. +### Requirements for the Mermaid API. When writing the html file, we give the web browser three instructions inside the html code: @@ -64,12 +79,11 @@ b. The mermaid code for the diagram we want to create. c. The `mermaid.initialize()` call, which can dictate the appreance of diagrams and also start the rendering process . - **a. A reference to the external CDN in a ` +
- Here is a mermaid diagram: -