通过 MarkDown 编写文档,可以自动生成 HTML 在线文档,并支持实时预览。这一切都可以借助 gitbook 来实现。
安装步骤
- 安装 node.js(Windows 版本)
- 打开 cmd,输入以下命令安装 gitbook:
npm install -g gitbook-cli - 新建一个文件夹,在该目录下打开 cmd,输入:
gitbook init生成结果如下图:
- 输入以下命令启动 gitbook,以便通过浏览器查看:
gitbook serve - 打开浏览器访问 127.0.0.1:4000
至此,gitbook 环境搭建完毕。
配置插件
在 gitbook 的项目目录下新建 book.json,写入以下内容:
{
"title": "用户手册",
"plugins": ["hide-element","chapter-fold"],
"pluginsConfig": {
"chapter-fold": {},
"hide-element": {
"elements": [".gitbook-link"]
}
}
}
上述配置包含两个插件:一个用于去掉 logo,另一个用于折叠菜单。
在命令行中依次执行以下命令安装插件:
gitbook install
然后执行以下命令生成 HTML 页面,生成的文件位于当前目录的 _book 文件夹中:
gitbook build
至此,即可通过 Markdown 编写并发布文档。