Merge pull request #5 from LiHowe/dev

merge dev to main

Author: LiHowe

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.1.14](https://github.com/LiHowe/vuepress-plugin-mermaid/compare/v0.1.13...v0.1.14) (2023-01-12)
+
+### [0.1.13-beta.0](https://github.com/LiHowe/vuepress-plugin-mermaid/compare/v0.1.10...v0.1.13) (2023-01-12)
+
+
+### Bug Fixes
+
+* fix issue[#1](https://github.com/LiHowe/vuepress-plugin-mermaid/issues/1) and issue[#2](https://github.com/LiHowe/vuepress-plugin-mermaid/issues/2) ([f3b78e7](https://github.com/LiHowe/vuepress-plugin-mermaid/commit/f3b78e7c1a217352b77bca3cd796dd190cdc7967))
+
 ### [0.1.10](https://github.com/LiHowe/vuepress-plugin-mermaid/compare/v0.1.9...v0.1.10) (2022-11-07)
 
 ### [0.1.9](https://github.com/LiHowe/vuepress-plugin-mermaid/compare/v0.1.8...v0.1.9) (2022-05-13)

README.md

@@ -1,10 +1,10 @@
 # vuepress-plugin-mermaid-next
 
-> This plugin is only for `vuepress-next`
+[中文说明](./README_ZH.md)
 
-## Usage
+> This plugin is only for [`vuepress-next`](https://vuepress.github.io)
 
-### Install
+## Installation
 
 ```shell
 # use npm
@@ -14,6 +14,8 @@ npm install mermaid vuepress-plugin-mermaid-next
 yarn add mermaid vuepress-plugin-mermaid-next
 ```
 
+## Usage
+
 ### `.vuepress/config.ts` or (`config.js`)
 
 ```typescript
@@ -36,11 +38,19 @@ export default {
 }
 ```
 
-### Custormize
+### Customization
 
 You can config mermaid by using plugin settings.
 
 The settings you configured will be use in `mermaid.initialize()`
 
 Fully configuration fields can be find in [Mermaid - Configuration](https://mermaid-js.github.io/mermaid/#/./Setup?id=mermaidapi-configuration-defaults)
 
+
+## Feature
+
+[x] Dark mode supported
+[x] mermaid config supported
+[ ] External Diagrams
+[ ] Preset themes
+

README_ZH.md

@@ -0,0 +1,53 @@
+# vuepress-plugin-mermaid-next
+
+> 该插件仅适用于 [`vuepress-next`](https://vuepress.github.io)
+
+## 安装
+
+```shell
+# use npm
+npm install mermaid vuepress-plugin-mermaid-next
+
+# use yarn
+yarn add mermaid vuepress-plugin-mermaid-next
+```
+
+## 使用
+
+### `.vuepress/config.ts` or (`config.js`)
+
+```typescript
+export default {
+  // ...
+  plugins: [
+    // ... 其他插件
+    ['mermaid-next', {}]
+  ]
+  // ...
+}
+// or 
+import MermaidPlugin from 'vuepress-plugin-mermaid-next'
+export default {
+  plugins: [
+    MermaidPlugin({
+      // 插件选项
+    })
+  ]
+}
+```
+
+### 自定义
+
+你可以传入插件配置来自定义mermaid, 传入的配置将会用于 `mermaid.initialize()`
+
+Mermaid 完整的配置字段可以查看 [Mermaid - Configuration](https://mermaid-js.github.io/mermaid/#/./Setup?id=mermaidapi-configuration-defaults)
+
+
+
+## 功能
+
+[x] Dark mode supported
+[x] mermaid config supported
+[ ] External Diagrams
+[ ] Preset themes
+

docs/.vuepress/config.ts

@@ -1,8 +1,7 @@
-import mermaidPlugin from '../../lib/node/index'
-import { defineUserConfig } from 'vuepress'
+// import mermaidPlugin from '../../lib/node/index'
 
-export default defineUserConfig({
+export default {
   plugins: [
-    mermaidPlugin({})
+    // mermaidPlugin({})
   ]
-})
+}