GitBook搭建¶

1.安装GitBook¶

需要node环境 ➡️ NVM安装使用)

# 如果没有安装gitbook,此命令会默认同时安装 GitBook
npm install gitbook -g
npm install -g gitbook-cli

# 查看版本
gitbook -V

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

Tips:GitBook常用命令¶

gitbook -V 查看版本号
gitbook init 初始化
gitbook serve 预览
gitbook build 生成
gitbook build --gitbook=3.2.3 生成时指定gitbook的版本, 本地没有会先下载
gitbook uninstall 3.2.3 卸载指定版本号的gitbook
gitbook fetch [version] 获取[版本]下载并安装<版本>
gitbook --help 显示帮助文档
gitbook ls-remote 列出NPM上的可用版本：

2.创建目录，初始化¶

mkdir gitbook-imsdk   // 创建项目目录
cd gitbook-imsdk
gitbook init  // 初始化目录

gitbook init这个命令会生成两个模板文件，一个 README.md，可以理解为封面；还有一个是 SUMMARY.md,就是目录了。

SUMMARY.md 可以参考这个：

# 目录

- [前言](README.md)

- [GitBook](GitBook/README.md)
    - [NVM安装使用](GitBook/NVM安装使用.md)
    - [GitBook搭建](GitBook/GitBook搭建.md)

3.部署、发布、输出pdf¶

执行 gitbook serve 命令，将其部署在本地，打开 Chrome 访问：http://localhost:4000，即可看到本地部署的 Gitbook（注：serve 命令可以指定端口 gitbook serve --port 1234）

执行 gitbook build 命令构建书籍，默认将生成的静态网站输出到 _book 目录。实际上，这一步也包含在 gitbook serve 里面（注：build 命令可以指定路径 gitbook build [书籍路径] [输出路径]，如果你想查看输出目录详细的记录，可使用 gitbook build ./ --log=debug --debug 来查看）

输出为 PDF 文件，需要先安装 gitbook pdf

# 安装
npm install gitbook-pdf -g
# 生成pdf
gitbook pdf {book_name}

4.卸载GitBook¶

找到C:\Users{User}.gitbook 找到并删除此文件夹

npm uninstall -g gitbook
npm uninstall -g gitbook-cli
# 清除npm缓存
npm cache clean -f