Skip to content

Commit f59b4f2

Browse files
authored
Merge pull request #30 from corentinleberre/update-v10
👽 Update plugin to be compatible with mermaid V10
2 parents 7d3a3e6 + 2cc4978 commit f59b4f2

File tree

6 files changed

+8553
-5577
lines changed

6 files changed

+8553
-5577
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,24 @@ mermaid-docsify is a docsify plugin which allows to render mermaid diagrams in d
55
Add Mermaid and the plugin:
66

77
```html
8-
<script src="//unpkg.com/mermaid/dist/mermaid.js"></script>
9-
<script src="//unpkg.com/docsify-mermaid@latest/dist/docsify-mermaid.js"></script>
10-
<script>mermaid.initialize({ startOnLoad: true });</script>
8+
<script type="module">
9+
import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
10+
mermaid.initialize({ startOnLoad: true });
11+
window.mermaid = mermaid;
12+
</script>
13+
<script src="dist/docsify-mermaid.js"></script>
14+
```
15+
16+
You can optionally customize [mermaid.run](https://mermaid.js.org/config/usage.html#using-mermaid-run) configuration with this props :
17+
18+
```html
19+
<script>
20+
window.$docsify = {
21+
mermaidConfig: {
22+
querySelector: ".mermaid"
23+
}
24+
};
25+
</script>
1126
```
1227

1328
Now you can include mermaid diagrams in your docsify docs:

example/index.html

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,26 @@
1313

1414
<body>
1515
<div id="app"></div>
16-
17-
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
18-
<script src="//unpkg.com/mermaid/dist/mermaid.js"></script>
19-
<script src="dist/docsify-mermaid.js"></script>
16+
2017
<script>
18+
window.$docsify = {
19+
name: "docsify-mermaid",
20+
mermaidConfig: {
21+
querySelector: ".mermaid"
22+
}
23+
};
24+
</script>
25+
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
26+
<script type="module">
27+
import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
2128
mermaid.initialize({
2229
startOnLoad: true,
2330
securityLevel: 'loose',
2431
logLevel: 1
2532
});
33+
window.mermaid = mermaid;
2634
</script>
27-
35+
<script src="dist/docsify-mermaid.js"></script>
2836
</body>
2937

3038
</html>

0 commit comments

Comments
 (0)