起因
原先小王使用有道云笔记来记录文档, 最近在使用中发现一些不便, 如页内跳转, 预览查看等。在查看一些框架官网时发现这种文档展示方式有很多优点, 不仅目录结构清晰, 而且支持站内搜索跳转, 外链跳转。加上可配置插件, 增强了扩展性, 极大的提升了用户的阅读体验。小王准备打造一个专注于内容创作,网站实时更新的工作流。
graph
markdown编辑 --> git推送--> 网站实时更新
选用 docsify
初步查看发现 vue 官网使用的是 vuepress 框架, 小王立即去 vuepress 官网查看使用, 但在版本 2.0.0-beta.25 的使用中遇见了一些问题, 乱码和config.js 配置无法热更新。在查询以后发现热更是个遗留问题, 最后在官网中看到为什么不是板块, 我尝试了 docsify, 感觉开发体验更好, 配置简单, 一系列插件可以直接引入 CDN.最后我选择了 docsify
选取标准
- 专注内容创作
- 不需要 SEO
- 开源
本地搭建与开发
- npm i docsify-cli -g
- docsify init ./docs
- docsify serve docs
详细配置和使用查看
部署 gh-pages 网站
确保选择的分支目录中存在 index.html
vscode 插件 markdown all in one
vscode插件 markdown 编辑利器 插件市场
使用方式 : ctrl + shift + p 输入 markdown 可看到很多功能,比较常用的有创建章节序号和目录。
总结
至此一个完成的流程搭建成功啦,只需要git下来,vscode中编辑markdown文件,最后推送到github,网站就会实时更新,是不是很方便。附带网站链接,看做好的成品 网站链接,想要打造个人文章,个人博客都是可以的,内容自己来定。