• 起因
• 选用 docsify

  • 本地搭建与开发
  • 部署 gh-pages 网站
• vscode 插件 markdown all in one

  • 插件市场
• 我的文章链接

Part1起因

原先小王使用有道云笔记来记录文档, 最近在使用中发现一些不便, 如页内跳转, 预览查看等。在查看一些框架官网时发现这种文档展示方式有很多优点, 不仅目录结构清晰, 而且支持站内搜索跳转, 外链跳转。加上可配置插件, 增强了扩展性, 极大的提升了用户的阅读体验。小王准备打造一个专注于内容创作，网站实时更新的工作流。

markdown 编辑 ---> git 推送 ---> 网站实时更新

Part2选用 docsify

初步查看发现 vue 官网使用的是 vuepress 框架, 小王立即去 vuepress 官网查看使用, 但在版本 2.0.0-beta.25 的使用中遇见了一些问题, 乱码和config.js 配置无法热更新。在查询以后发现热更是个遗留问题, 最后在官网中看到为什么不, 我尝试了 docsify, 感觉开发体验更好, 配置简单, 一系列插件可以直接引入 CDN.最后我选择了 docsify

选取标准

1. 专注内容创作
2. 不需要 SEO
3. 开源

1本地搭建与开发

1. npm i docsify-cli -g
2. docsify init ./docs
3. docsify serve docs

详细配置和使用查看

1. docsify 官网
2. 参考本案例

2部署 gh-pages 网站

确保选择的分支目录中存在 index.html

Part3我的文章链接