SilverBulletZyp

Gitbook使用教程

2017/11/13

Gitbook详细教程

  • 安装准备

需要Node.js、GitBook、GitBook Editor、Git

  • 开源地址

Gitbook

安装

  • 全局安装gitbook CLI
命令 描述
npm install gitbook-cli -g 安装命令
npm update gitbook-cli -g 更新命令
npm uninstall gitbook -g 卸载命令
  • 查看安装状态
命令 描述
gitbook -V 查看版本
which gitbook 查找路径

下载

git clone https://github.com/tinyclub/open-shell-book.git
cd open-shell-book/

编译

  • 编译成静态网页
gitbook build  // 编译成网页

会生成_book目录，为完整的HTML静态网站

  • 生成书籍
gitbook pdf    // 编译成 pdf
gitbook epub   // 编译成 epub
gitbook mobi    // 编译成 mobi

需要提前安装Calibre，Gitbook会使用其中的ebook-convert功能组件来完成书籍格式的转换

  • 安装Calibre

创建Gitbook

初始化

gitbook init
  • README.md - 项目的介绍都写在这个文件里。
  • SUMMARY.md - GitBook 的目录结构在这里配置。

定义目录结构

可先在SUMMARY.md里自行写完目录使用gitbook init自动生成 或创建好文件夹和文件再编辑SUMMARY.md

  • 示例目录（之后gitbook init即可）
# Summary

* [项目简介](README.md)
* [快速开始](docs/快速开始.md)
 * [环境搭建](docs/环境搭建.md)
 * [简单使用](docs/简单使用.md)
* [学入学习](docs/深入学习)

注:gitbook init 只支持生成两级目录

启动服务

gitbook serve

会先编译书籍gitbook build

  • 查看效果

http://localhost:4000/ 或 http://127.0.0.1:4000/

  • 可在线给他人阅读
ifconfig // 获得ip地址后加入端口

Post Directory