Gitbook最全初始配置

2024-01-12 15:33:52

一、GitBook 简介

gitbook 是一个基于node.js命令的工具，可以使用网络常见的github|git和Markdown来制作精美的电子书，而且和typora软件搭配是一款非常好的笔记记录软件，下面我们一起来了解它的入门需知吧

语法简单
兼容性强
导出方便
专注内容
团队协作

二、安装

安装软件：Git、Typora

Typora 下载地址：https://typora.io/

Git 下载地址：https://git-scm.com/downloads

安装 Node.js

GitBook 是一个基于 Node.js 的命令行工具，下载安装 [Node.js]https://nodejs.org/zh-cn/)，安装完成之后，你可以使用下面的命令来检验是否安装成功。

三、使用

1.全局安装`gitbook-cli`输入下面的命令来安装 GitBook。

npm install gitbook-cli -g

2.新建文件夹(英文命名如：myboot)

gitbook init

README.md —— 书籍的介绍写在这个文件里
SUMMARY.md —— 书籍的目录结构在这里配置

3.启动Typora编辑器，引入文件夹

4.编辑目录`SUMMARY.md`

# Summary

* [目录](README.md)
* [第一章](notes/1-0.md)
    * [第1节：](notes/1-1.md)
    * [第2节：](notes/1-2.md)
    * [第3节：](notes/1-3.md)
    * [第4节：](notes/1-4.md)
* [第二章](notes/2-0.md)
* [第三章](notes/3-0.md)
* [第四章](notes/4-0.md)

5.再次执行`gitbook init`，生成新目录结构

6.浏览器浏览：`gitbook serve`

执行 gitbook serve 来预览这本书籍，执行命令后会对 Markdown 格式的文档进行转换，默认转换为 html 格式，最后提示 “Serving book on http://localhost:4000”

7.构建书籍：`gitbook build`

[x] 默认：将生成的静态网站输出到 _book 目录
[x] 指定路径：gitbook build [书籍路径] [输出路径]
[x] 指定端口：gitbook serve --port 2333
[x] 生成pdf格式：gitbook pdf ./ ./mybook.pdf
[x] 生成epub格式：gitbook epub ./ ./mybook.epub
[x] 生成 mobi 格式：gitbook mobi ./ ./mybook.mobi

注意：如果生成不了，你可能还需要安装一些工具，比如 calibre、ebook-convert，或者在 Typora 中安装 Pandoc 进行导出。

8.gitbook附加命令

npm i -g gitbook-cli |  npm install gitbook-cli -g  //安装环境

gitbook init //初始化目录文件

gitbook help //列出gitbook所有的命令

gitbook --help //输出gitbook-cli的帮助信息

gitbook build //生成静态网页

gitbook serve //生成静态网页并运行服务器

gitbook build --gitbook=2.0.1 //生成时指定gitbook的版本, 本地没有会先下载

gitbook ls //列出本地所有的gitbook版本

gitbook ls-remote //列出远程可用的gitbook版本

gitbook fetch 标签/版本号 //安装对应的gitbook版本

gitbook update //更新到gitbook的最新版本

gitbook uninstall 2.0.1 //卸载对应的gitbook版本

gitbook build --log=debug //指定log的级别

gitbook builid --debug //输出错误信息1234567891011121312345678910111213

四、目录结构

GitBook 基本的目录结构如下所示：

.
├── book.json
├── README.md
├── SUMMARY.md
├── notes/
|   ├── 1-0.md
|   └── 1-1.md
|   ├── 1-2.md
|   └── 1-3.md

下面我们主要来讲讲 book.json 和 SUMMARY.md 文件。

book.json

该文件主要用来存放配置信息，我先放出我的配置文件。

相信很多节点自己也能猜到是什么意思，我还是简单介绍下吧。

title

本书标题

author

本书作者

description

本书描述

language

本书语言，中文设置 "zh-hans" 即可

gitbook

指定使用的 GitBook 版本

styles

自定义页面样式

structure

指定 Readme、Summary、Glossary 和 Languages 对应的文件名

links

在左侧导航栏添加链接信息

plugins

配置使用的插件

pluginsConfig

配置插件的属性

SUMMARY.md

这个文件主要决定 GitBook 的章节目录，它通过 Markdown 中的列表语法来表示文件的父子关系，下面是一个简单的示例：

# Summary

* [目录](README.md)
* [第一章](notes/1-0.md)
    * [第1节：](notes/1-1.md)
    * [第2节：](notes/1-2.md)
    * [第3节：](notes/1-3.md)
    * [第4节：](notes/1-4.md)
* [第二章](notes/2-0.md)
* [第三章](notes/3-0.md)
* [第四章](notes/4-0.md)

这个配置对应的目录结构如下所示:

我们通过使用 标题 或者 水平分割线 将 GitBook 分为几个不同的部分，如下所示：

# Summary

### Part I

* [目录](README.md)

### Part II

* [第一章](notes/1-0.md)
    * [第1节：](notes/1-1.md)
    * [第2节：](notes/1-2.md)
    * [第3节：](notes/1-3.md)
    * [第4节：](notes/1-4.md)

---

* [第二章](notes/2-0.md)
* [第三章](notes/3-0.md)
* [第四章](notes/4-0.md)

插件

GitBook 有插件官网，默认带有 5 个插件，highlight、search、sharing、font-settings、livereload，如果要去除自带的插件，可以在插件名称前面加 -，比如：

"plugins": [
    "-search"
]

如果要配置使用的插件可以在 book.json 文件中加入即可，比如我们添加 plugin-github，我们在 book.json 中加入配置如下即可：

{
    "plugins": [ "github" ],
    "pluginsConfig": {
        "github": {
            "url": "https://github.com/13469940053/Web_notes"
        }
    }
}

然后在终端输入 gitbook install ./ 即可。

如果要指定插件的版本可以使用 plugin@0.3.1，因为一些插件可能不会随着 GitBook 版本的升级而升级。

五、用 Git 做版本管理

在远端建好git仓库，在 mybook 目录下执行 git init 初始化仓库，执行 git remote add 添加远程仓库。接着就可以愉快地 commit，push，pull …

码农公寓