Skip to content

Commit 3046325

Browse files
Merge pull request #49 from emersonbottero/more-improvements
fix: type export and docs!
2 parents cae5724 + ab17e18 commit 3046325

File tree

5 files changed

+1173
-17
lines changed

5 files changed

+1173
-17
lines changed

docs/guide/getting-started.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@ mermaidTheme: base
77
This section will help you add mermaid support for VitePress.
88

99
::: warning
10+
🚧 From version 2.0.11 and up charts that uses dates don't work in dev mod but still work after build!
1011
You can still highlight mermaid code with mmd as language
1112
:::
1213

1314
## Install
1415

1516
```bash
16-
npm i vitepress-plugin-mermaid mermaid @mermaid-js/mermaid-mindmap -D
17+
npm i vitepress-plugin-mermaid mermaid -D
1718
```
1819

1920
## Setup it up
@@ -22,18 +23,15 @@ Add wrapper
2223

2324
```js
2425
// .vitepress/config.js
25-
import { defineConfig } from "vitepress";
2626
import { withMermaid } from "vitepress-plugin-mermaid";
2727

28-
export default withMermaid(
29-
defineConfig({
28+
export default withMermaid({
3029
// your existing vitepress config...
3130
// optionally, you can pass MermaidConfig
3231
mermaid: {
3332
// refer https://mermaid.js.org/config/setup/modules/mermaidAPI.html#mermaidapi-configuration-defaults for options
3433
},
35-
})
36-
);
34+
});
3735
```
3836

3937
Use in any Markdown file

0 commit comments

Comments
 (0)