Gitbook使用

Gitbook使用

笔者测试环境:windows 7 旗舰版 64位操作系统

前言:Gitbook是一个命令行工具(node.js库), 可使用Gitbook创建漂亮的图书。

要点:图书的基本要素至少包含两个文件: README.md 和 SUMMARY.md。

 

必需相关文件

典型的, 它应该是你的图书的介绍。它可以自动的被加到最终的summary中。
SUMMARY.md 定义了你的图书的目录结构, 它应该包含章节的列表,以及它们的链接。

Gitbook相关命令说明:

图书初始化

//图书初始化,若没有SUMMARY.md和README.md文件,则自动创建。

gitbook init [path] 
本地预览
gitbook serve [path] 或
gitbook serve [path] -p 8080 //path为图书目录所在路径;8080为自定义的端口
生成静态网站

//path:为图书目录所在路径。

//outputFolder:静态网站存放的目录路径。

gitbook build path --output= outputFolder //=号右边一定要有空格

Gitbook serve和Gitbook build 的相关参数:

    -o, --output <directory>  输出文件件, 默认为 ./_book。
    -f, --format <name>       书籍的类型,默认为静态站点, 可用的格式为: site,page, ebook, json。
    --config <config file>    配置文件, 默认为 book.js 或 book.json。

输出格式

  • 静态站点: 默认格式, 创建一个完全交互式的静态网站,可以发布到GitHub等网站。
  • eBook: 图书完成后可以使用它创建电子书。创建命令: gitbook ebook ./mybook。
    你需要安装 ebook-convert,输出格式可以是PDF,ePub 或 MOBI。
  • 单页网页: 可以生成一个单页的HTML网页。这个格式可以用来转换PDF或者eBook. 创建命令: gitbook build ./myrepo -f page。
  • JSON: 此格式用来调试或者抽取图书的元数据,创建命令: gitbook build ./mybook -f json。

忽略文件和文件夹

       GitBook 读取.gitignore,.bookignore 和 .ignore 得到需要忽略的文件/文件夹的列表。 (文件的格式和 .gitignore一样)。


Gitbook 应用实例

步骤如下:

1. 在D盘上新建图书目录:docbook;
2. 在docbook目录下新建README.md文件,输入图书的介绍。
3. 在docbook目录下新建SUMMARY.md文件,输入图书的目录结构(利用markdown)。
4. 打开git中(或cmd)命令窗口,切换至图书目录docbook。
5. 输入命令:gitbook serve。
6. 打开浏览器,请入git(cmd)命令窗口提示的 serving book on <url> 中的url。
7. 根据SUMMARY.md文件的目录结构相对应的文件,编辑图书内容。

相关截图:

summary.md

       SUMMARY.md

gitbook serve

       gitbook serve

文章导航