Skip to content

Commit

Permalink
Merge pull request #1199 from GDFaber/bug/fix_mermaidAPI_configuratio…
Browse files Browse the repository at this point in the history
…n_example_in_the_docs

Fix mermaidAPI configuration example in the docs
  • Loading branch information
knsv committed Jan 15, 2020
2 parents c0e1c90 + 36f9eca commit efa810d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
12 changes: 7 additions & 5 deletions docs/mermaidAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ These are the default options which can be overridden with the initialization ca
<pre>
mermaid.initialize({
flowchart:{
htmlLabels: false
htmlLabels: false
}
});
</pre>

**Example 2:**

<pre>
<script>
&lt;script>
var config = {
startOnLoad:true,
flowchart:{
Expand All @@ -39,10 +39,10 @@ mermaid.initialize({
securityLevel:'loose',
};
mermaid.initialize(config);
</script>

&lt;/script>
</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

Expand Down Expand Up @@ -333,3 +333,5 @@ mermaidAPI.initialize({
</pre>

[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 changes: 3 additions & 3 deletions src/mermaidAPI.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,14 @@ for (const themeName of ['default', 'forest', 'dark', 'neutral']) {
* <pre>
* mermaid.initialize({
* flowchart:{
* htmlLabels: false
* htmlLabels: false
* }
* });
* </pre>
*
* **Example 2:**
* <pre>
* <script>
* &lt;script>
* var config = {
* startOnLoad:true,
* flowchart:{
Expand All @@ -71,7 +71,7 @@ for (const themeName of ['default', 'forest', 'dark', 'neutral']) {
* securityLevel:'loose',
* };
* mermaid.initialize(config);
* </script>
* &lt;/script>
* </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.
*
Expand Down

0 comments on commit efa810d

Please sign in to comment.