https://www.bilibili.com/video/BV1fM4y1V7uv

vue-cli-2.0请移步：

https://gitee.com/zglzglzgl/readme-webpack-plugin

1. cli

vue add readme

2. vue-cli UI

启动项目后，终端会提示一个地址：http://localhost:1234

1. 两种创建记录的语法

   书写一条记录语法会在客户端生成一个记录。

   • 类HTML注释语法

       <!--## 
       #{1 - type - title}# 
       markdown
       ###-->

   • 类JavaScript注释语法

       /*#### 
       #{1 - type - title}# 
       markdown
       ####*/

2. 关联记录

   通过标题最后一个参数去关联父记录的id

   

3. 删除记录

4. 更新源码

5. 与已有 markdown 进行整合

   在项目根目录下新建一个BASE-README.md文件，此文件中的markdown自动被收集到客户端中。

   

配置代码提示后，输入‘#’号提示记录语法模板

"JS readme-webpack-plugin template syntax1": {
     "scope": "",
     "prefix": "#",
     "body": [
       "/*#### \n #{1 - todo - title}# \n markdown \n ####*/"
     ],
     "description": ""
},

"HTML readme-webpack-plugin template syntax2": {
     "scope": "",
     "prefix": "#",
     "body": [
       "<!--## \n #{1 - todo - title}# \n markdown \n ###-->"
     ],
     "description": ""
}