Gitbook 简介

图书项目结构

README.mdSUMMARY.md 是Gitbook项目必备的两个文件,也就是一本最简单的gitbook也必须含有这两个文件,它们在一本Gitbook中具有不同的用处。

在Gitbook中所有文字的编写都使用Markdown语法。

Gitbook 使用入门

Gitbook 使用入门

GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书。

本书将简单介绍如何安装、编写、生成、发布一本在线图书。

GitBook支持输出多种文档格式,如:

  • 静态站点:GitBook默认输出该种格式,生成的静态站点可直接托管搭载Github Pages服务上;
  • PDF:需要安装gitbook-pdf依赖;
  • eBook:需要安装ebook-convert;
  • 单HTML网页:支持将内容输出为单页的HTML,不过一般用在将电子书格式转换为PDF或eBook的中间过程;
  • JSON:一般用于电子书的调试或元数据提取。
  • 仓库:https://github.com/tonydeng/gitbook-zh/tree/master/gitbook-howtouse
  • 在线阅读:http://tonydeng.github.io/gitbook-zh/gitbook-howtouse

Gitbook 输出PDF

输出PDF

输出为PDF文件,需要先安装gitbook pdf

$ npm install gitbook-pdf -g

如果在安装gitbook-pdf时,觉得下载phantomjs包太慢的话,你可以到phantomjs的官方网站上去下载。

Gitbook 输出格式

图书输出

目前为止,Gitbook支持如下输出:

  • 静态HTML,可以看作一个静态网站
  • PDF格式
  • eBook格式
  • 单个HTML文件
  • JSON格式

我们这里着重说下如何输出静态的HTML和PDF文件。

Gitbook 输出为静态网站

输出为静态网站

你有两种方式输出一个静态的网站:

当你编辑好gitbook文档之后,你可以使用gitbook的命令来进行本地预览。

$ gitbook serve ./{book_name}

gitbook会启动一个4000端口用于预览。