Skip to content

Commit e204ac6

Browse files
docs: correct mermaid docs after upgrade marked (#2490)
--------- Co-authored-by: Luffy <52o@qq52o.cn>
1 parent 87b5683 commit e204ac6

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/markdown.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Markdown configuration
22

3-
**docsify** uses [marked](https://github.com/markedjs/marked) as its Markdown parser. You can customize how it renders your Markdown content to HTML by customizing `renderer`:
3+
**docsify** uses [marked v13+](https://github.com/markedjs/marked) as its Markdown parser. You can customize how it renders your Markdown content to HTML by customizing `renderer`:
44

55
```js
66
window.$docsify = {
@@ -31,23 +31,24 @@ window.$docsify = {
3131

3232
## Supports mermaid
3333

34+
!> Currently, docsify doesn't support the async mermaid render (the latest mermaid version supported is `v9.3.0`).
35+
3436
```js
35-
// Import mermaid
3637
// <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css">
37-
// <script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
38+
// <script src="//cdn.jsdelivr.net/npm/mermaid@9.3.0/dist/mermaid.min.js"></script>
3839

3940
let num = 0;
4041
mermaid.initialize({ startOnLoad: false });
4142

4243
window.$docsify = {
4344
markdown: {
4445
renderer: {
45-
code(code, lang) {
46+
code({ text, lang }) {
4647
if (lang === 'mermaid') {
4748
return /* html */ `
4849
<div class="mermaid">${mermaid.render(
4950
'mermaid-svg-' + num++,
50-
code,
51+
text,
5152
)}</div>
5253
`;
5354
}

0 commit comments

Comments
 (0)