> For the complete documentation index, see [llms.txt](https://gyx8899.gitbook.io/blog/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gyx8899.gitbook.io/blog/docs/gitbook.md).

# GitBook

## 安装

* 安装 gitbook-cli，执行后续 gitbook 命令会自动安装最新版本的 gitbook

```shell
npm install gitbook-cli -g
```

* 初始化书籍目录，
  1. 初次执行生成 README.md 和 SUMMERY.md 文件；
  2. 手动修改 SUMMERY.md 的目录结构，再次执行，则会自动生成新增目录结构中的文件；

```shell
gitbook init
```

* 编译和预览书籍

```shell
gitbook serve
```

* 编译

```shell
gitbook build
```

* 安装定义在 book.json 中的 plugin

```shell
gitbook install
```

* 查看安装版本

```shell
gitbook -V

CLI version: 2.3.2
GitBook version: 3.2.3
```