Electron开发实战之记帐软件16——使用Docsify生成文档网站

代码仓库： https://github.com/hilanmiao/LanMiaoDesktop

官网中文文档：https://docsify.js.org/#/zh-cn/quickstart

在平常开发中 先后端对接时 常常要写不少文档Api。docsify就是一个强大的文档生成工具 界面清新好 支持语法高亮和Markdown 语法，而且docsify 扩展了一些 Markdown 语法能够让文档更易读。像vue.js官网(https://cn.vuejs.org/)就是docsify 其中的一种注意 而且是目前用的的最多的主题。

安装docsify

npm i docsify-cli -g // 安装全局
docsify init ./docs // 初始化项目
docsify serve docs // 本地预览

初始化成功后，能够看到 ./docs 目录下建立的几个文件

• index.html 入口文件
• README.md 会作为主页内容渲染
• .nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件

初始化后默认是复制了根目录下的ReadME.md,你能够本身编辑。 本地预览效果

部署Github pages

GitHub Pages 支持从三个地方读取文件

docs/ 目录 master 分支 gh-pages 分支 咱们推荐直接将文档放在 docs/ 目录下，在Setting页面开启 GitHub Pages 功能并选择 master branch /docs folder 选项，马上就能生成了。

能够打开我github pages 预览一下：https://hilanmiao.github.io/LanMiaoDesktop/#/

优化

docsify的配置项有不少，你能够挨着试试，并且还有一些高级的功能，像ssr等，有兴趣的本身研究下。

这是个人文件结构和最终效果展现，具体代码请查看个人仓库，直接拷贝过来用便可。