GitBook 用法

GitBook是一个使用GitHub/Git和Markdown/AsciiDoc用来构建漂亮的书籍的工具。

要求


安装好了nodejs和npm。

全局安装GitBook


使用npm来安装GitBook。

$ npm install gitbook-cli -g

初始化一本书籍


可以使用gitbook init命令来初始化一本书籍,但是这里我们手动来初始化。
建立一下的文件结构。

├───zh/
│   └───INTRO.md
│   └───SUMMARY.md
└───INTRO.md
└───LANGS.md
└───book.json

book.json文件是GitBook的配置文件。这里我们需要指定GitBook的版本、语言、结构(修改默认的readme文件名)。

{
    "gitbook": ">=2.0.0",
    "language": "zh",
    "structure": {
        "readme": "INTRO.md"
    }
}

LANGS.md文件用来说明本书有哪几种语言版本。这里只设置了中文版,并且书籍在zh目录下。

* [中文版](zh/)

INTRO.md(默认情况下是readme.md)是用来介绍书籍的介绍页。

# title
description

SUMMARY.md是用来定义书籍的目录的。

# Summary

* [Part I](part1/README.md)
    * [Writing is nice](part1/writing.md)
    * [GitBook is nice](part1/gitbook.md)
* [Part II](part2/README.md)
    * [We love feedback](part2/feedback_please.md)
    * [Better tools for authors](part2/better_tools.md)

接下来就可以开始书籍的写作了。

发布静态网站


书籍写好了可以发布成PDF, ePub, mobi或者静态网站任意一种形式。

$ gitbook build

执行了上面的命令后,就会在当前目录下生成一个_book目录,里面就是本书的网站形式了。

你可能感兴趣的:(GitBook 用法)