mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-20 15:59:51 +02:00
doc: Add mindmap integration docs
This commit is contained in:
@@ -235,3 +235,17 @@ Root
|
|||||||
B
|
B
|
||||||
C
|
C
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Integrating with your library/website.
|
||||||
|
|
||||||
|
Mindmap uses the experimental lazy loading & async rendering features which could change in the future.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script type="module">
|
||||||
|
import mermaid from 'https://unpkg.com/mermaid@9/dist/mermaid.esm.min.mjs';
|
||||||
|
import mindmap from 'https://unpkg.com/@mermaid-js/mermaid-mindmap@9/dist/mermaid-mindmap.esm.min.mjs';
|
||||||
|
await mermaid.registerExternalDiagrams([mindmap]);
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
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.
|
||||||
|
@@ -119,6 +119,10 @@ Rendering in Mermaid is initialized by `mermaid.initialize()` call. You can plac
|
|||||||
| ----------- | --------------------------------- | ------- | ----------- |
|
| ----------- | --------------------------------- | ------- | ----------- |
|
||||||
| startOnLoad | Toggle for Rendering upon loading | Boolean | true, false |
|
| startOnLoad | Toggle for Rendering upon loading | Boolean | true, false |
|
||||||
|
|
||||||
|
### Adding external diagrams to mermaid
|
||||||
|
|
||||||
|
Please refer to the [Mindmap](./mindmap.md?id=integrating-with-your-librarywebsite) section for more information.
|
||||||
|
|
||||||
### Working Examples
|
### Working Examples
|
||||||
|
|
||||||
**Here is a full working example of the mermaidAPI being called through the CDN:**
|
**Here is a full working example of the mermaidAPI being called through the CDN:**
|
||||||
|
@@ -153,3 +153,17 @@ Root
|
|||||||
B
|
B
|
||||||
C
|
C
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Integrating with your library/website.
|
||||||
|
|
||||||
|
Mindmap uses the experimental lazy loading & async rendering features which could change in the future.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script type="module">
|
||||||
|
import mermaid from '<CDN_URL>/mermaid@<MERMAID_VERSION>/dist/mermaid.esm.min.mjs';
|
||||||
|
import mindmap from '<CDN_URL>/@mermaid-js/mermaid-mindmap@<MERMAID_VERSION>/dist/mermaid-mindmap.esm.min.mjs';
|
||||||
|
await mermaid.registerExternalDiagrams([mindmap]);
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
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.
|
||||||
|
@@ -117,6 +117,10 @@ Rendering in Mermaid is initialized by `mermaid.initialize()` call. You can plac
|
|||||||
| ----------- | --------------------------------- | ------- | ----------- |
|
| ----------- | --------------------------------- | ------- | ----------- |
|
||||||
| startOnLoad | Toggle for Rendering upon loading | Boolean | true, false |
|
| startOnLoad | Toggle for Rendering upon loading | Boolean | true, false |
|
||||||
|
|
||||||
|
### Adding external diagrams to mermaid
|
||||||
|
|
||||||
|
Please refer to the [Mindmap](./mindmap.md?id=integrating-with-your-librarywebsite) section for more information.
|
||||||
|
|
||||||
### Working Examples
|
### Working Examples
|
||||||
|
|
||||||
**Here is a full working example of the mermaidAPI being called through the CDN:**
|
**Here is a full working example of the mermaidAPI being called through the CDN:**
|
||||||
|
Reference in New Issue
Block a user