1. 前言
主要记录 GitBook 的安装配置以及一些插件信息,当前使用的 GitBook 版本为 3.2.3
。
推荐一下 docsify,相当于一个精简的 GitBook,不需要编译,使用很方便。这里 基于 doscify 做了一些修改,具体的效果可以看一下 在线的示例 .
1.1. 运行
- 安装 GitBook
npm install gitbook-cli -g
- Clone 代码到本地并运行
git clone git@github.com:zhangjikai/gitbook-use.git cd gitbook-use gitbook install gitbook serve
- 在浏览器中打开
http://localhost:4000/
进行访问
1.2. 目录
1.3. GitBook 资源
2. 地球号Gitbook文档书写规范
地球号相关开发都用Markdown书写文档,并用Gitbook生成静态网站。为了方便地球号开发经验积累,文档交流。地球号对文档书写做了一些规范。本文档描述了这些规范。
参考Gitbook插件下载网站。进入网站,搜索gitbook plugin_example
就可以查询相关插件。