Skip to content

Commit 82a93a0

Browse files
committed
update readme
1 parent 85b73fe commit 82a93a0

File tree

2 files changed

+46
-40
lines changed

2 files changed

+46
-40
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,9 @@ amd default plugins options:
103103
anchorLinkSpace: false,
104104
anchorClassName: 'anchor',
105105
anchorLinkSymbolClassName: 'octicon octicon-link'
106+
},
107+
mermaid: {
108+
theme: 'default'
106109
}
107110
}
108111
```
@@ -137,7 +140,7 @@ PR for you lang wich you want.
137140
- MATLAB
138141
- Ruby
139142
- Perl
140-
- Objective-C
143+
- Objective-C
141144
- Rust
142145
- Dart
143146
- Delphi

README_CN.md

Lines changed: 42 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
> Markdonw Vue 组件库.
66
7-
markdown-it-vue 是一个丰富的 markdown Vue 组件,markdown-it-vue 使用 markdown-it 作为 Markdown 数据解析引擎,整合多种 markdown-it 插件,并内置了一些自己的功能性插件,支持 GFM TOC、GFM style、emoji等通用特性,还支持 mermaid charts、Echarts、flowchart.js 等多种图表,支持 AsciiMath、Latex 等数学公式渲染,支持 errro | warning | info 个性化提示。
7+
markdown-it-vue 是一个丰富的 markdown Vue 组件,markdown-it-vue 使用 markdown-it 作为 Markdown 数据解析引擎,整合多种 markdown-it 插件,并内置了一些自己的功能性插件,支持 GFM TOC、GFM style、emoji 等通用特性,还支持 mermaid charts、Echarts、flowchart.js 等多种图表,支持 AsciiMath、Latex 等数学公式渲染,支持 errro | warning | info 个性化提示。
88

99
## 在线示例
1010

@@ -20,50 +20,50 @@ npm install markdown-it-vue
2020

2121
## 特性
2222

23-
* Official markdown syntax.
24-
* GFM TOC
25-
* GFM style
26-
* emoji
27-
* [mermaid charts](http://knsv.github.io/mermaid/)
28-
* [Echarts](http://echarts.baidu.com)
29-
* Flowcharts.js
30-
* Subscript/Superscript
31-
* [AsciiMath](http://asciimath.org/)
32-
* info | error | warning message tip
23+
- Official markdown syntax.
24+
- GFM TOC
25+
- GFM style
26+
- emoji
27+
- [mermaid charts](http://knsv.github.io/mermaid/)
28+
- [Echarts](http://echarts.baidu.com)
29+
- Flowcharts.js
30+
- Subscript/Superscript
31+
- [AsciiMath](http://asciimath.org/)
32+
- info | error | warning message tip
3333

3434
## 使用的插件
3535

36-
* markdown-it
37-
* markdown-it-emoji
38-
* markdown-it-sub
39-
* markdown-it-sup
40-
* markdown-it-footnote
41-
* markdown-it-deflist
42-
* markdown-it-abbr
43-
* markdown-it-ins
44-
* markdown-it-mark
45-
* markdown-it-katex
46-
* markdown-it-task-lists
47-
* markdown-it-icons
48-
* markdown-it-highlight
49-
* markdown-it-latex
50-
* markdown-it-container
51-
* markdown-it-github-toc
52-
* markdown-it-source-map
53-
* markdown-it-link-attributes
36+
- markdown-it
37+
- markdown-it-emoji
38+
- markdown-it-sub
39+
- markdown-it-sup
40+
- markdown-it-footnote
41+
- markdown-it-deflist
42+
- markdown-it-abbr
43+
- markdown-it-ins
44+
- markdown-it-mark
45+
- markdown-it-katex
46+
- markdown-it-task-lists
47+
- markdown-it-icons
48+
- markdown-it-highlight
49+
- markdown-it-latex
50+
- markdown-it-container
51+
- markdown-it-github-toc
52+
- markdown-it-source-map
53+
- markdown-it-link-attributes
5454

5555
内置插件:
5656

57-
* markdown-it-font-awsome
58-
* markdown-it-link-attributes
59-
* markdown-it-highlight
60-
* markdown-it-plugin-echarts
61-
* markdown-it-plugin-mermaid
62-
* markdown-it-plugin-flowchart
57+
- markdown-it-font-awsome
58+
- markdown-it-link-attributes
59+
- markdown-it-highlight
60+
- markdown-it-plugin-echarts
61+
- markdown-it-plugin-mermaid
62+
- markdown-it-plugin-flowchart
6363

6464
## markdown-it 及个插件选项
6565

66-
使用 `options` 指定 markdow-it 和个插件的选项。
66+
使用 `options` 指定 markdow-it 和个插件的选项。
6767

6868
```html
6969
<markdown-it-vue class="md-body" :content="content" :options="options" />
@@ -108,6 +108,9 @@ options: {
108108
anchorLinkSpace: false,
109109
anchorClassName: 'anchor',
110110
anchorLinkSymbolClassName: 'octicon octicon-link'
111+
},
112+
mermaid: {
113+
theme: 'default'
111114
}
112115
}
113116
```
@@ -146,7 +149,7 @@ this.$refs.myMarkdownItVue.use(MyMarkdownItPlugin)
146149
- MATLAB
147150
- Ruby
148151
- Perl
149-
- Objective-C
152+
- Objective-C
150153
- Rust
151154
- Dart
152155
- Delphi
@@ -190,7 +193,7 @@ https://github.com/ravenq/markdown-it-vue/issues/24
190193
```vue
191194
<template>
192195
<div>
193-
<markdown-it-vue class="md-body" :content="content"/>
196+
<markdown-it-vue class="md-body" :content="content" />
194197
</div>
195198
</template>
196199
@@ -201,7 +204,7 @@ export default {
201204
components: {
202205
MarkdownItVue
203206
},
204-
data () {
207+
data() {
205208
return {
206209
content: '# your markdown content'
207210
}

0 commit comments

Comments
 (0)