Home Diary Blog Photo Community Open Source
Installation and use of GitBook

GitBook 安装以及使用

Installation and use of GitBook


本地通过 NPM 安装 GitBook 命令行工具

运行下面的命令进行安装

$ npm install gitbook-cli -g

其中 gitbook-cli 是 gitbook 的一个命令行工具,安装成功后,执行gitbook -V查看版本信息。此命令会默认同时安装 GitBook

GitBook 创建以及预览

1. 初始化

  1. 打开一个文件夹 MyGitBook,使用 gitbook init 初始化文件夹,会自动生成两个必要的文件 README.md 和 SUMMARY.md。
$ gitbook init
  • README.md: 书的介绍文字,如前言、简介,在章节中也可做为章节的简介。
  • SUMMARY.md: 定制书籍的章节结构和顺序。

README.md 和 SUMMARY.md 是 GitBook 制作电子书的必要文件,可用 gitbook init 命令自动生成。

2. 在 MyGitBook 文件夹下面增加其他章节下的文件,文件目录如下:

_book
Chapter1
Chatper2
README.md
SUMMARY.md
  1. GitBook 使用 SUMMARY.md 文件作为书籍的目录结构,可以用来制作书籍目录。
// SUMMARY.md

# Summary
* [Introduction](README.md)
* Part I
    * [从命令行进行测试](Chapter1/CommandLine.md)
    * [Monkey](Chapter1/Monkey.md)
    * [monkeyrunner 参考](Chapter1/MonkeyrunnerReference.md)
        * [概览](Chapter1/MonkeyrunnerSummary.md)
        * [MonkeyDevice](Chapter1/MonkeyDevice.md)
        * [MonkeyImage](Chapter1/MonkeyImage.md)
        * [MonkeyRunner](Chapter1/MonkeyRunner.md)
* Part II
    * [Introduction](Chapter2/c1.md)
    * [Introduction](Chapter2/c2.md)
    * [Introduction](Chapter2/c3.md)
    * [Introduction](Chapter2/c4.md)

2.预览

  1. 执行命令 gitbook serve ,gitbook 会启动一个 4000 端口用于预览。
$ gitbook serve

你可以你的浏览器中打开这个网址: http://localhost:4000 预览电子书效果。

  1. 第二种预览方式,运行 gitbook build 命令后会在书籍的文件夹中生成一个 _book 文件夹, 里面的内容即为生成的 html 文件. 我们可以使用下面命令来生成网页而不开启服务器。
$ gitbook build