zglz/vue-cli-plugin-readme


Vue-Cli-Plugin-Readme

我们可以在任何源码中写 markdown，并且提供了一个可交互的markdown管理客户端。

视频教程

[视频地址](https://www.bilibili.com/video/BV1fM4y1V7uv): https://www.bilibili.com/video/BV1fM4y1V7uv

安装方法

vue add element

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

使用方式

1. 两种创建记录的语法

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

   • 类HTML注释语法

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

   • 类JavaScript注释语法

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

2. 关联记录

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

   

3. 删除记录

   

4. 更新源码

   

5. 与已有 markdown 进行整合

   通过设置 base:'BASE-README' 与已有 markdown 进行整合

   

原理图

VScode代码片段

"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": ""
}