GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-28 07:03:17 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1199 from GDFaber/bug/fix_mermaidAPI_configuration_example_in_the_docs

Browse Source 
Fix mermaidAPI configuration example in the docs
This commit is contained in:
Knut Sveidqvist 2020-01-15 16:50:11 +01:00 committed by GitHub
commit efa810da91
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/mermaidAPI.md
View File

@ -19,7 +19,7 @@ These are the default options which can be overridden with the initialization ca
<pre> <pre>
mermaid.initialize({ mermaid.initialize({
flowchart:{ flowchart:{
htmlLabels: false htmlLabels: false
} }
}); });
</pre> </pre>
@ -27,7 +27,7 @@ mermaid.initialize({
**Example 2:** **Example 2:**
<pre> <pre>
<script> &lt;script>
var config = { var config = {
startOnLoad:true, startOnLoad:true,
flowchart:{ flowchart:{
@ -39,10 +39,10 @@ mermaid.initialize({
securityLevel:'loose', securityLevel:'loose',
}; };
mermaid.initialize(config); mermaid.initialize(config);
</script> &lt;/script>
</pre> </pre>
A summary of all options and their defaults is found [here](https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#mermaidapi-configuration-defaults). A description of each option follows below.
A summary of all options and their defaults is found [here][2]. A description of each option follows below.
## theme ## theme
@ -333,3 +333,5 @@ mermaidAPI.initialize({
</pre> </pre>
[1]: https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#render [1]: https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#render
[2]: https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#mermaidapi-configuration-defaults

6
src/mermaidAPI.js
View File

@ -52,14 +52,14 @@ for (const themeName of ['default', 'forest', 'dark', 'neutral']) {
* <pre> * <pre>
* mermaid.initialize({ * mermaid.initialize({
* flowchart:{ * flowchart:{
* htmlLabels: false * htmlLabels: false
* } * }
* }); * });
* </pre> * </pre>
* *
* **Example 2:** * **Example 2:**
* <pre> * <pre>
* <script> * &lt;script>
* var config = { * var config = {
* startOnLoad:true, * startOnLoad:true,
* flowchart:{ * flowchart:{
@ -71,7 +71,7 @@ for (const themeName of ['default', 'forest', 'dark', 'neutral']) {
* securityLevel:'loose', * securityLevel:'loose',
* }; * };
* mermaid.initialize(config); * mermaid.initialize(config);
* </script> * &lt;/script>
* </pre> * </pre>
* A summary of all options and their defaults is found [here](https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#mermaidapi-configuration-defaults). A description of each option follows below. * A summary of all options and their defaults is found [here](https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#mermaidapi-configuration-defaults). A description of each option follows below.
* *