Merge pull request #18 from mermaid-js/develop

Merge

Author: jgreywolf

README.md

@@ -5,13 +5,46 @@
 <!-- </Remove this in the future> -->
 
 # mermaid [![Build Status](https://travis-ci.org/mermaid-js/mermaid.svg?branch=master)](https://travis-ci.org/mermaid-js/mermaid) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Mermaid/mermaid)
+
 <!-- <Main description> -->
-__Generate diagrams, charts, graphs or flows from markdown-like text via javascript.__
-See our [documentation](http://mermaid-js.github.io/mermaid/) and start simplifying yours. Play in our [live editor](https://mermaidjs.github.io/mermaid-live-editor/) or jump straight to the [installation and usage](http://mermaid-js.github.io/mermaid/#/usage).
-<!-- </Main description> -->
+__mermaid is a Javascript based diagramming and charting tool. It generates diagrams flowcharts and more, using markdown-inspired text for ease and speed.__
+
+Check out the list of [Integrations and Usages of Mermaid](https://github.com/mermaid-js/mermaid/blob/develop/docs/integrations.md)
+
+For more information and help in getting started, please view our [documentation](http://mermaid-js.github.io/mermaid/) and start simplifying yours. Alternatively, you can also play with our [live editor](https://mermaidjs.github.io/mermaid-live-editor/).
+<!-- </Main description> --> 
+
+:trophy: **Mermaid was nominated and won the [JS Open Source Awards (2019)](https://osawards.com/javascript/#nominees) in the category "The most exciting use of technology"!!! Thanks to all involved, people committing pull requests, people answering questions and special thanks to Tyler Long who is helping me maintain the project.**
+
+## New diagrams in 8.4
+
+With version 8.4 class diagrams have got some new features, bug fixes and documentation. Another new feature in 8.4 is the new diagram type, state diagrams.
+
+![Image show the two new diagram types](.docs/img/new-diagrams.png)
 
-:trophy: _"The most exciting use of technology"_ - [JS Open Source Awards (2019)](https://osawards.com/javascript/#nominees)
+## Special note regarding version 8.2
+
+In version 8.2 a security improvement was introduced. A securityLevel configuration was introduced which sets the level of trust to be used on the parsed diagrams.
+
+- **true**: (default) tags in text are encoded, click functionality is disabled
+- false: tags in text are allowed, click functionality is enabled
+
+Closed issues:
+
+⚠️ **Note** : This changes the default behaviour of mermaid so that after upgrade to 8.2, if the securityLevel is not configured, tags in flowcharts are encoded as tags and clicking is prohibited.
+
+If your application is taking resposibility for the diagram source security you can set the securityLevel accordingly. By doing this clicks and tags are again allowed.
+
+```javascript
+mermaidAPI.initialize({
+    securityLevel: 'loose'
+});
+```
+
+For more information and help in getting started, please view our [documentation](http://mermaid-js.github.io/mermaid/) and start simplifying yours. Play with our [live editor](https://mermaidjs.github.io/mermaid-live-editor/) or jump straight to the [installation and usage](http://mermaid-js.github.io/mermaid/#/usage).
+<!-- </Main description> -->
 
+__The following are some examples of the diagrams, charts and graphs that can be made using mermaid and the Markdown-inspired text specific to it. Click here jump into the [text syntax](https://mermaid-js.github.io/mermaid/#/n00b-syntaxReference).__
 <table>
 <!-- <Flowchart> -->
 <tr><td colspan=2 align="center">

cypress/integration/rendering/flowchart.spec.js

@@ -524,7 +524,8 @@ describe('Flowchart', () => {
       { flowchart: { htmlLabels: false } }
     );
   });
-it('25: Handle link click events (link, anchor, mailto, other protocol, script)', () => {
+
+  it('25: Handle link click events (link, anchor, mailto, other protocol, script)', () => {
     imgSnapshotTest(
       `graph TB
       TITLE["Link Click Events<br>(click the nodes below)"]
@@ -583,6 +584,39 @@ it('25: Handle link click events (link, anchor, mailto, other protocol, script)'
       { flowchart: { htmlLabels: false } }
     );
   });
+
+  it('28: Apply default class to all nodes which do not have another class assigned (htmlLabels enabled)', () => {
+    imgSnapshotTest(
+      `graph TD
+      A[myClass1] --> B[default] & C[default]
+      B[default] & C[default] --> D[myClass2]
+      classDef default stroke-width:2px,fill:none,stroke:silver
+      classDef node color:red
+      classDef myClass1 color:#0000ff
+      classDef myClass2 stroke:#0000ff,fill:#ccccff
+      class A myClass1
+      class D myClass2
+      `,
+      { flowchart: { htmlLabels: true } }
+    );
+  });
+
+  it('29: Apply default class to all nodes which do not have another class assigned (htmlLabels disabled)', () => {
+    imgSnapshotTest(
+      `graph TD
+      A[myClass1] --> B[default] & C[default]
+      B[default] & C[default] --> D[myClass2]
+      classDef default stroke-width:2px,fill:none,stroke:silver
+      classDef node color:red
+      classDef myClass1 color:#0000ff
+      classDef myClass2 stroke:#0000ff,fill:#ccccff
+      class A myClass1
+      class D myClass2
+      `,
+      { flowchart: { htmlLabels: false } }
+    );
+  });
+
   it('30: Possibility to style text color of nodes and subgraphs as well as apply classes to subgraphs', () => {
     imgSnapshotTest(
       `graph LR

dist/index.html

@@ -384,6 +384,17 @@
     click B "index.html#link-clicked" "link test"
     click D testClick "click test"
   </div>
+  <div class="mermaid">
+    graph TD
+    A[myClass1] --> B[default] & C[default]
+    B[default] & C[default] --> D[myClass2]
+    classDef default stroke-width:2px,fill:none,stroke:silver
+    classDef node color:red
+    classDef myClass1 color:#0000ff
+    classDef myClass2 stroke:#0000ff,fill:#ccccff
+    class A myClass1
+    class D myClass2
+  </div>
 
   <hr/>
 

docs/README.md

@@ -1,23 +1,33 @@
+# Mermaid
+
 [![Build Status](https://travis-ci.org/mermaid-js/mermaid.svg?branch=master)](https://travis-ci.org/mermaid-js/mermaid)
 [![Coverage Status](https://coveralls.io/repos/github/knsv/mermaid/badge.svg?branch=master)](https://coveralls.io/github/knsv/mermaid?branch=master)
 [![Join the chat at https://gitter.im/knsv/mermaid](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/knsv/mermaid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-# mermaid
+![banner](./img/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.
+
+Check out the list of [Integrations and Usages of Mermaid](./integrations.md)
+
+**Mermaid was nominated and won the JS Open Source Awards (2019) in the category "The most exciting use of technology"!!! Thanks to all involved, people committing pull requests, people answering questions and special thanks to Tyler Long who is helping me maintain the project.**
 
 ## New diagrams in 8.4
 
-With version 8.4 class diagrams has got some new features, bug fixes and documentation. Another new feature in 8.4 is the new diagram
-type, state diagrams.
+With version 8.4 class diagrams have got some new features, bug fixes and documentation. Another new feature in 8.4 is the new diagram type, state diagrams.
 
 ![Image show the two new diagram types](./img/new-diagrams.png)
 
-
 ## Special note regarding version 8.2
 
 In version 8.2 a security improvement was introduced. A securityLevel configuration was introduced which sets the level of trust to be used on the parsed diagrams.
 
-* **true**: (default) tags in text are encoded, click functionality is disabled
-* false: tags in text are allowed, click functionality is enabled
+- **true**: (default) tags in text are encoded, click functionality is disabled
+- false: tags in text are allowed, click functionality is enabled
 
 Closed issues:
 
@@ -26,22 +36,14 @@ Closed issues:
 If your application is taking resposibility for the diagram source security you can set the securityLevel accordingly. By doing this clicks and tags are again allowed.
 
 ```javascript
-    mermaidAPI.initialize({
-        securityLevel: 'loose'
-    });
+mermaidAPI.initialize({
+    securityLevel: 'loose'
+});
 ```
 
 **🖖 Keep a steady pulse: mermaid needs more Collaborators [#866](https://github.com/knsv/mermaid/issues/866)**
 
-![banner](./img/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.
-
-**Mermaid was nominated and won the JS Open Source Awards (2019) in the category "The most exciting use of technology"!!! Thanks to all involved, people committing pull requests, people answering questions and special thanks to Tyler Long who is helping me maintain the project.**
+## Diagrams
 
 ### Flowchart
 
@@ -52,8 +54,8 @@ graph TD;
     B-->D;
     C-->D;
 ```
-![Flowchart](./img/flow.png)
 
+![Flowchart](./img/flow.png)
 
 ### Sequence diagram
 
@@ -70,8 +72,8 @@ sequenceDiagram
     John->>Bob: How about you?
     Bob-->>John: Jolly good!
 ```
-![Sequence diagram](./img/sequence.png)
 
+![Sequence diagram](./img/sequence.png)
 
 ### Gantt diagram
 
@@ -87,8 +89,8 @@ Active task               :active,  des2, 2014-01-09, 3d
 Future task               :         des3, after des2, 5d
 Future task2               :         des4, after des3, 5d
 ```
-![Gantt diagram](./img/gantt.png)
 
+![Gantt diagram](./img/gantt.png)
 
 ### Class diagram - :exclamation: experimental
 
@@ -108,8 +110,8 @@ Class01 : int chimp
 Class01 : int gorilla
 Class08 <--> C2: Cool label
 ```
-![Class diagram](./img/class.png)
 
+![Class diagram](./img/class.png)
 
 ### Git graph - :exclamation: experimental
 
@@ -135,7 +137,6 @@ merge newbranch
 
 ![Git graph](./img/git.png)
 
-
 ## Installation
 
 ### CDN
@@ -154,21 +155,18 @@ Example: https://unpkg.com/mermaid@7.1.0/dist/
 yarn add mermaid
 ```
 
-
 ## Documentation
 
 https://mermaidjs.github.io
 
-
 ## Sibling projects
 
 - [mermaid CLI](https://github.com/mermaidjs/mermaid.cli)
 - [mermaid live editor](https://github.com/mermaidjs/mermaid-live-editor)
 - [mermaid webpack demo](https://github.com/mermaidjs/mermaid-webpack-demo)
 - [mermaid Parcel demo](https://github.com/mermaidjs/mermaid-parcel-demo)
 
-
-# Request for assistance
+## Request for assistance
 
 Things are piling up and I have a hard time keeping up. To remedy this
 it would be great if we could form a core team of developers to cooperate
@@ -178,61 +176,62 @@ As part of this team you would get write access to the repository and would
 represent the project when answering questions and issues.
 
 Together we could continue the work with things like:
-* adding more types of diagrams like mindmaps, ert diagrams, etc.
-* improving existing diagrams
 
-Don't hesitate to contact me if you want to get involved.
+- Adding more types of diagrams like mindmaps, ert diagrams, etc.
+- Improving existing diagrams
 
+Don't hesitate to contact me if you want to get involved.
 
-# For contributors
-
-## Setup
-
-    yarn install
+## For contributors
 
+### Setup
 
-## Build
+```
+yarn install
+```
 
-    yarn build:watch
+### Build
 
+```
+yarn build:watch
+```
 
-## Lint
+### Lint
 
-    yarn lint
+```
+yarn lint
+```
 
 We use [eslint](https://eslint.org/).
 We recommend you installing [editor plugins](https://eslint.org/docs/user-guide/integrations) so you can get real time lint result.
 
+### Test
 
+```
+yarn test
+```
+Manual test in browser: open `dist/index.html`
 
-## Test
-
-    yarn test
-
-Manual test in browser:
-
-    open dist/index.html
-
-
-## Release
+### Release
 
 For those who have the permission to do so:
 
 Update version number in `package.json`.
 
-    npm publish
+```
+npm publish
+```
 
 Command above generates files into the `dist` folder and publishes them to npmjs.org.
 
-
-# Credits
+## 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. Thanks to Jessica Peter for inspiration and starting point for gantt rendering.
 
-*Mermaid was created by Knut Sveidqvist for easier documentation.*
+_Mermaid was created by Knut Sveidqvist for easier documentation._
 
-*[Tyler Long](https://github.com/tylerlong) has became a collaborator since April 2017.*
+_[Tyler Long](https://github.com/tylerlong) has became a collaborator since April 2017._
 
 Here is the full list of the projects [contributors](https://github.com/knsv/mermaid/graphs/contributors).

docs/development.md

@@ -3,9 +3,31 @@
 
 ## Updating the documentation
 
-We write documention with GitBook.
+Please continue writing documentation at [mermaid-js/mermaid/docs](https://github.com/mermaid-js/mermaid/tree/develop/docs).
 
-Please continue with the [mermaid-gitbook](https://github.com/mermaidjs/mermaid-gitbook) project.
+We publish documentation using GitHub Pages.
+
+
+### Questions and/or suggestions ?
+After logging in at [GitHub.com](https://www.github.com), open or append to an issue [using the GitHub issue tracker of the mermaid-js repository](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Documentation%22).
+
+### How to contribute a suggestion
+Markdown is used to format the text, for more information about Markdown [see the GitHub Markdown help page](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).
+
+If you want to use an editor on your own computer, you may follow these steps:
+* Find the Markdown file (.md) to edit in the [mermaid-js/mermaid/docs](https://github.com/mermaid-js/mermaid/tree/develop/docs) directory on the develop branch.
+* Create a fork of the develop branch.
+* Make changes or add new documentation.
+* Commit changes to your fork and push it to GitHub.
+* Create a pull request of your fork.
+
+If you don't have such editor on your computer, you may follow these steps:
+* Login at [GitHub.com](https://www.github.com).
+* Navigate to [mermaid-js/mermaid/docs](https://github.com/mermaid-js/mermaid/tree/develop/docs).
+* To edit a file, click the pencil icon at the top-right of the file contents panel.
+* Describe what you changed in the "Propose file change" section, located at the bottom of the page.
+* Submit your changes by clicking the button "Propose file change" at the bottom (by automatic creation of a fork and a new branch).
+* Create a pull request of your newly forked branch, by clicking the green "Create pull request" button.
 
 
 ## How to add a new diagram type