PRISM-VUE-DOC

PRISM-VUE-DOC

A Beautiful md generator you should know

用于可以写Vue Demo的 markdown 环境，inspired by You-need-to-know-css

相关依赖

1. docsify 文档md -> 静态网站 的工具，需全局安装
2. vuep 可以在md文档中直接写 Vue 组件代码的工具，直接显示效果
3. prism 一个精致的 markdown 文档主题
4. gitalk 评论回复插件，复用

项目用途

1. 用于前端团队交流Vue代码片段，写技术分享md使用
2. 用于前端团队沉淀技术，积累踩坑经验
3. 用于团队约定流程和代码规范之类的文档位置，方便新人融入团队
4. 可以作为wiki使用，轻量方便，对前端友好

项目特点

1. 使用了定制主题的markdown，UI和交互都用了比较成熟的方案
2. 已经本地引入了大部分插件，不依赖CDN，方便内网部署
3. 引入了搜索插件，方便作为知识库来使用
4. 拥有评论能力，方便留言交流。

项目启动

• clone此仓库到本地。
• npm install docsify -g全局安装
• 在此项目下执行docsify serve
• 打开 http://localhost:3000 即可看到效果
• 此时可以在项目下自己增加md文件，本地即可看到修改效果

license

996ICU © 2017-present, LHammer