一个简单易用的文档生成器. 预览。 快速的将众多 Markdown 文件生成结构化的网站，并一键部署至 github。
- 敏捷。只有一个脚本(gzip 后约 3k)，没有任何框架。
- 简单。只需要运行一个命令。
- 懒加载，首屏加载更快。
- 适应移动设备。
- 更多的主题。
- 安装：
npm i -g simpler-paper。 - 初始化：
paper init，帮助你创建一个配置文件。 - 添加文档：
- 不要忘了在文档文件夹中添加你的 Markdown 文件。
- 创建
assets文件夹来存储图片。 - 多层目录的菜单结构是按文档的目录层次决定的，无需配置。
- 改变文件顺序，如使某个文件夹或 xxx.md 排列在更前面，只需要为文件或文件夹的名称增加数字前缀即可， 这些数字代表着权重，类似于 CSS z-index：100000_install.md (我知道你经常这样干🙄🙄)。
- 构建：
paper build。运行paper server进行本地预览。 - 部署：
paper deploy。确保当前操作目录为 Git 仓库。 完成部署后设置 为 GitHub pages 。
配置文件是 paper init 过程中指定文档文件夹下的 paper.config.json 。
运行
paper init命令可以快速创建配置文件。
// paper.config.json
{
// 文档别名, 单个文档对应的别名, 不创建默认使用文件名 默认值: null
"alias": {
"quickstart": "Getting Started",
...
},
// 文档标题, 默认值: "simpler paper"
"title": "",
// 在文档右侧生成迷你目录地图, 默认值: true
"minimap": true,
// 返回至顶部的按钮, 默认值: true
"backToTop": true,
// 文档的路径, 默认值: "/"
"docPath": "/",
// 加载指示器, 默认值: true
"indicator": true
}