【笔记】Gitbook学习笔记

发表于 更新于 阅读次数：

前言

Gitbook学习笔记

下载依赖

1
npm install -g gitbook-cli@2.1.2

初始化项目

创建目录

1
2
mkdir docs
cd docs

通过cli工具初始化项目

1
gitbook init

手动初始化项目

1
2
3
- SUMMARY.md
- file1.md
- file2.md
SUMMARY.md
1
2
* [file1](file1.md)
  * [file2](file2.md)

启动服务

1
gitbook serve

编译项目

1
gitbook build

排除文件的配置

  • 创建.bookignore文件来定义排除的目录和文件

配置文件

book.json
1
2
3
4
5
6
7
8
9
10
{
  "title": "图书标题",
  "description": "图书描述",
  "isbn": "图书编号",
  "author": "作者",
  "lang": "zh-CN",
  "plugins": [],
  "pluginsConfig": {},
  "variables": {}
}

插件配置

初始化为npm项目

1
npm init

安装搜索插件

  • 可以搜索任何utf8字符，对中文支持良好，并在搜索结果中高亮搜索关键词

下载依赖

1
npm install gitbook-plugin-search-pro

修改配置

book.json
1
2
3
{
  "plugins": ["-lunr", "-search", "search-pro"]
}

安装代码块插件

  • 为代码块添加行号和一键复制按钮

下载依赖

1
npm install gitbook-plugin-code

修改配置

book.json
1
2
3
4
5
6
7
8
{
  "plugins": ["code"],
  "pluginsConfig": {
    "code": {
      "copyButton": true
    }
  }
}

安装菜单折叠插件

下载依赖

1
npm install gitbook-plugin-expandable-chapters

修改配置

book.json
1
2
3
{
  "plugins": ["expandable-chapters"]
}

安装返回顶部插件

下载依赖

1
npm install gitbook-plugin-back-to-top-button

修改配置

book.json
1
2
3
{
  "plugins": ["back-to-top-button"]
}

完成

参考文献

哔哩哔哩——程序猿松露
stackoverflow——J–