电子书制作工具 GitBook

2022-01-24 约 1282 字预计阅读 3 分钟次阅读

GitBook 的简介

GitBook /ɡɪt/bʊk/ 是一个基于 Node.js 的命令行工具，可使用 Github/Git 和 Markdown 来制作精美的电子书（例如：IT 行业技术说明书）。前提需要安装 npm（注：Node.js 都会默认安装 npm，具体请参考笔记《网站 node 包管理器 npm》）注意：node.js(npm) 版本过高，GitBook 不支持（运行命令时提示各种错误），目前建议安装 node-v10.24.1-linux-x64.tar.xz。
官网：gitbook

Ubuntu 平台

1、gitbook 的安装

GitBook 的安装很简单，只需要通过 NPM 工具安装即可。（NPM 请阅读《网站 node 包管理器 npm》）
网文：gitbook 的安装与使用

1
2
3
4
5


npm install -g gitbook-cli  #安装GitBook电子书构建工具  
gitbook -V                  #查看及检查是否最新版本,否则安装最新版本  
                            #运行上行命令提示出错：TypeError: cb.apply is not a function  
                            #问题原因：node.js(npm) 版本过高，GitBook 不支持！  
                            #解决方法：卸载高版本，安装低版本（如：v10.x，全部版本在：https://nodejs.org/dist/）  

2、gitbook 的使用

电子书其实主要包括三部分内容：目录、文章介绍、具体章节。编写这三部分的 markdown 文档，再使用 gitbook 构建静态网页。
网文：gitbook 的安装与使用

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


gitbook init   #在当前目录初始电子书（生成两文件:
               #                      README.md   书籍的介绍在这个文件里，  
               #                      SUMMARY.md  书籍的目录结构在这里配置）  
               #                                  目录语法为Markdown的无序列表+本地文件链接，例如：  
               #                                  * [简介](README.md)  
               #                                  * [第一章](./part1/README.md)  
               #                                      * [第一节](./part1/1.md)  
               #                                  * [第二章](part2/README.md)  
gitbook build  #构建生成静态网页（创建 _book 目录）  
#gitbook build --format=website  #指定输出格式: `website`（默认,静态网页）
#gitbook build --format=json     #指定输出格式: `json`
#gitbook build --format=ebook    #指定输出格式: `ebook`
gitbook serve  #启动本地Web服务 （在浏览器打开 http://localhost:4000/ 预览书籍）  

3、gitbook 的发布

方式一：将静态网页托管到托管到 Gitbook

在 Gitbook.com 为此本书创建一个 git 仓库（配置相关参数）；
拷贝 git 地址，然后git clone到本地；
在本地按照 Gitbook 规范编辑电子书，然后git push到 Gitbook 的远程仓库。其默认访问地址是：https://用户名.gitbooks.io/项目名/content/

具体请参考电子书：gitbook.com 官网操作

方式二：将静态网页托管到 GitHub Pages

直接将_book/里面的所有文件（静态网页）托管到 GitHub Pages 上，具体操作请参考：《博客生成工具 Hugo》之【4、Hugo 的发布】。建议与提醒：只有一本电子书（静态网页）托管到主页站点上是不值得的事，不如建一个人博客，再链接电子书的项目站点（普通项目代码仓库配置为静态网页站点即可，访问地址为https://username.github.io/代码仓库名）；
关于 Github Pages，是 GitHub 的一个功能，其允许用户在 GitHub 仓库托管你的个人、组织或项目的静态页面（自动识别 html、css、javascript）。与创建代码仓库操作步骤一样，不同是要指定仓库名称格式为username.github.io，username 改为你的 GitHub 账户名。