marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-08-27 12:16:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix timeline and mindmap

Browse Source
This commit is contained in:
Sidharth Vinod
2023-02-16 16:52:15 +05:30
parent 276f042983
commit b22978dfb2
4 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/syntax/mindmap.md
View File

@@ -270,11 +270,13 @@ You can still use the pre 9.4.0 method to add mermaid with mindmaps to a web pag
From version 9.4.0 you can simplify this code to: From version 9.4.0 you can simplify this code to:
<script type="module"> ```html
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.esm.min.mjs'; <script type="module">
</script> import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.esm.min.mjs';
</script>
```
or is you prefere not using an esm package: or if you prefer not using the ESM package:
```html ```html
<script src="https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.min.js"></script>
@@ -282,4 +284,4 @@ or is you prefere not using an esm package:
Note that more complex integrations that use the **render** function directly need to use the **renderAsync** method instead in order to render mind maps. Note that more complex integrations that use the **render** function directly need to use the **renderAsync** method instead in order to render mind maps.
You can also refer the implementation in the live editor [here](https://github.com/mermaid-js/mermaid-live-editor/blob/fcf53c98c25604c90a218104268c339be53035a6/src/lib/util/mermaid.ts) to see how the async loading is done. You can also refer the implementation in the live editor [here](https://github.com/mermaid-js/mermaid-live-editor/blob/develop/src/lib/util/mermaid.ts) to see how the async loading is done.

4
docs/syntax/timeline.md
View File

@@ -469,6 +469,6 @@ You can use this method to add mermaid including the timeline diagram to a web p
<script src="https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.min.js"></script>
``` ```
Note that more complex integrations that the **render** function directly need to use the **renderAsync** method instead in order to render mind maps. Note that more complex integrations that the **render** function directly need to use the **renderAsync** method instead in order to render timeline.
You can also refer the implementation in the live editor [here](https://github.com/mermaid-js/mermaid-live-editor/blob/fcf53c98c25604c90a218104268c339be53035a6/src/lib/util/mermaid.ts) to see how the async loading is done. You can also refer the implementation in the live editor [here](https://github.com/mermaid-js/mermaid-live-editor/blob/develop/src/lib/util/mermaid.ts) to see how the async loading is done.

6
packages/mermaid/src/docs/syntax/mindmap.md
View File

@@ -178,13 +178,13 @@ You can still use the pre 9.4.0 method to add mermaid with mindmaps to a web pag
From version 9.4.0 you can simplify this code to: From version 9.4.0 you can simplify this code to:
``` ```html
<script type="module"> <script type="module">
import mermaid from '<CDN_URL>/mermaid@<MERMAID_VERSION>/dist/mermaid.esm.min.mjs'; import mermaid from '<CDN_URL>/mermaid@<MERMAID_VERSION>/dist/mermaid.esm.min.mjs';
</script> </script>
``` ```
or is you prefere not using an esm package: or if you prefer not using the ESM package:
```html ```html
<script src="<CDN_URL>/mermaid@<MERMAID_VERSION>/dist/mermaid.min.js"></script> <script src="<CDN_URL>/mermaid@<MERMAID_VERSION>/dist/mermaid.min.js"></script>
@@ -192,4 +192,4 @@ or is you prefere not using an esm package:
Note that more complex integrations that use the **render** function directly need to use the **renderAsync** method instead in order to render mind maps. Note that more complex integrations that use the **render** function directly need to use the **renderAsync** method instead in order to render mind maps.
You can also refer the implementation in the live editor [here](https://github.com/mermaid-js/mermaid-live-editor/blob/fcf53c98c25604c90a218104268c339be53035a6/src/lib/util/mermaid.ts) to see how the async loading is done. You can also refer the implementation in the live editor [here](https://github.com/mermaid-js/mermaid-live-editor/blob/develop/src/lib/util/mermaid.ts) to see how the async loading is done.

4
packages/mermaid/src/docs/syntax/timeline.md
View File

@@ -301,6 +301,6 @@ You can use this method to add mermaid including the timeline diagram to a web p
<script src="<CDN_URL>/mermaid@<MERMAID_VERSION>/dist/mermaid.min.js"></script> <script src="<CDN_URL>/mermaid@<MERMAID_VERSION>/dist/mermaid.min.js"></script>
``` ```
Note that more complex integrations that the **render** function directly need to use the **renderAsync** method instead in order to render mind maps. Note that more complex integrations that the **render** function directly need to use the **renderAsync** method instead in order to render timeline.
You can also refer the implementation in the live editor [here](https://github.com/mermaid-js/mermaid-live-editor/blob/fcf53c98c25604c90a218104268c339be53035a6/src/lib/util/mermaid.ts) to see how the async loading is done. You can also refer the implementation in the live editor [here](https://github.com/mermaid-js/mermaid-live-editor/blob/develop/src/lib/util/mermaid.ts) to see how the async loading is done.