File tree Expand file tree Collapse file tree 3 files changed +86
-2
lines changed Expand file tree Collapse file tree 3 files changed +86
-2
lines changed Original file line number Diff line number Diff line change 1010
1111## Install
1212
13- ```
13+ ``` sh
1414npm install markdown-it-vue
1515```
1616
@@ -22,9 +22,10 @@ npm install markdown-it-vue
2222* emoji
2323* [ mermaid charts] ( http://knsv.github.io/mermaid/ )
2424* [ Echarts] ( http://echarts.baidu.com )
25+ * Flowcharts.js
2526* Subscript/Superscript
2627* [ AsciiMath] ( http://asciimath.org/ )
27- * Custom Container
28+ * info | error | warning message tip
2829
2930## Plugin list
3031
Original file line number Diff line number Diff line change 1+ # markdown-it-vue
2+
3+ [ ![ Build Status] ( https://travis-ci.org/ravenq/markdown-it-vue.svg?branch=master )] ( https://travis-ci.org/ravenq/markdown-it-vue )
4+
5+ > Markdonw Vue 组件库.
6+
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 个性化提示。
8+
9+ ## 在线示例
10+
11+ [ http://www.aqcoder.com/markdown ] ( http://www.aqcoder.com/markdown )
12+
13+ ## 安装
14+
15+ ``` sh
16+ npm install markdown-it-vue
17+ ```
18+
19+ ## 特性
20+
21+ * Official markdown syntax.
22+ * GFM TOC
23+ * GFM style
24+ * emoji
25+ * [ mermaid charts] ( http://knsv.github.io/mermaid/ )
26+ * [ Echarts] ( http://echarts.baidu.com )
27+ * Flowcharts.js
28+ * Subscript/Superscript
29+ * [ AsciiMath] ( http://asciimath.org/ )
30+ * info | error | warning message tip
31+
32+ ## 使用的插件
33+
34+ * markdown-it
35+ * markdown-it-emoji
36+ * markdown-it-sub
37+ * markdown-it-sup
38+ * markdown-it-footnote
39+ * markdown-it-deflist
40+ * markdown-it-abbr
41+ * markdown-it-ins
42+ * markdown-it-mark
43+ * markdown-it-katex
44+ * markdown-it-task-lists
45+ * markdown-it-icons
46+ * markdown-it-highlight
47+ * markdown-it-latex
48+ * markdown-it-container
49+ * markdown-it-github-toc
50+ * markdown-it-source-map
51+
52+ ## 使用示例
53+
54+ ``` vue
55+ <template>
56+ <div>
57+ <markdown-it-vue class="md-body" :content="content"/>
58+ </div>
59+ </template>
60+
61+ <script>
62+ import MarkdownItVue from 'markdown-it-vue'
63+ import 'markdown-it-vue/dist/markdown-it-vue.css'
64+ export default {
65+ components: {
66+ MarkdownItVue
67+ },
68+ data () {
69+ return {
70+ content: '# your markdown content'
71+ }
72+ }
73+ }
74+ </script>
75+ ```
76+
77+ ## 示例截图
78+
79+ ![ markdown-it-vue] ( https://github.com/ravenq/markdown-it-vue/blob/master/doc/markdown-it-vue.png?raw=true )
80+
81+ ## License
82+
83+ [ MIT] ( https://github.com/ravenq/markdown-it-vue/blob/master/LICENSE )
You can’t perform that action at this time.
0 commit comments