Rum 的题解越来越多,原先选择 Gitbook 构建解题本的弊端逐渐显现出来,每次补充一道题解重新 build
项目时居然要花上 30 秒左右……
由于无法忍受 gitbook build
的速度和大量垃圾静态文件,我打算重新构建 Rum,因此有了与 docsify 的邂逅。
docsify 是什么?
官方的介绍是:
A magical documentation site generator.
与 Gitbook 和 VuePress 相同,docsify 是一个文档站点生成器。至于它究竟 magic 在何处,我将在后面说到。
快速开始
安装
首先全局安装 docsify-cli
:
npm i docsify-cli -g
初始化
假设我们要在 ./docs
子目录中编写文档,将该目录初始化:
docsify init ./docs
初始化后系统帮我们生成了一个 ./docs
目录,目录中包含以下文件:
index.html
:入口文件README.md
:将作为主页渲染.nojekyll
:阻止 Github Pages 忽略以下划线开头的文件
预览
使用以下命令启动本地服务器:
docsify serve