diff --git a/README.md b/README.md index 7f56b4ab8..44a6a2c19 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,16 @@ 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. * **`strict`**: (default) tags in text are encoded, click functionality is disabled -* `loose`: tags in text are allowed, click functionality is enabledClosed issues: +* `loose`: tags in text are allowed, click functionality is enabled ⚠️ **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 responsibility 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)** @@ -76,7 +76,7 @@ section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d -Future task2 : des4, after des3, 5d +Future task2 : des4, after des3, 5d ``` ![Gantt diagram](./img/gantt.png) @@ -131,9 +131,7 @@ merge newbranch ### CDN -``` -https://unpkg.com/mermaid@/dist/ -``` + https://unpkg.com/mermaid@/dist/ Replace `` with expected version number. @@ -141,9 +139,7 @@ Example: https://unpkg.com/mermaid@7.1.0/dist/ ### Node.js -``` -yarn add mermaid -``` + yarn add mermaid ## Documentation