gitbook 简明教程

准备开发环境

1. 安装 Node.js

   从在 Node.js 官网下载 Node.js。

   会现在一个 .msi 文件，直接安装就好。

   安装过程中会有一个选项，问你是否要自动安装 Node.js 缺失的依赖。这个选项默认是否的，我没有勾选，安装完成之后也没有遇到依赖问题。

   在命令行中运行 node -v，判断是否安装成功。

2. 安装 gitbook

   安装好 Node.js 之后也自动安装好了 npm。npm 是 Node.js 的包管理器，有点类似于 Python 的 pip。运行以下命令安装 gitbook。

    npm install gitbook-cli -g
   

尝试第一个项目

本节我们将创建 SUMMARY.md 和 README.md 文件，通过本地的 gitbook 工具将其渲染为 gitbook 页面，并在浏览器中预览。

1. 生成 SUMMARY.md 和 README.md 文件

   gitbook 运行时必须有这两个文件。

   创建 SUMMARY.md 文件，写入：

    # SUMMARY
   
    * [Chapter1](chapter1/README.md)
      * [Section1.1](chapter1/section1.1.md)
      * [Section1.2](chapter1/section1.2.md)
    * [Chapter2](chapter2/README.md)
   

   创建 README.md 文件，写入：

    # README
   
    This is a book powered by [GitBook](https://github.com/GitbookIO/gitbook).
   

2. gitbook 生成对应的文件与目录

   第一步只是写了本书有哪些章节，并没有创建对应的文件，gitbook 工具可以帮我们解决这个问题。

   在 README.md 和 SUMMARY.md 同级目录下运行命令：

    gitbook init
   

   运行完成之后会发现多出几个目录和文件，与我们在 SUMMARY.md 中描述的一模一样。

   接下来就把内容写到文件里面就好啦~

3. gitbook 本地渲染

   执行命令，在浏览器地址栏输入 127.0.0.1:4000 即可看到结果。

    gitbook serve
   

   • 可能遇到的错误

     我在执行这一步的时候遇到了错误

     Error: ENOENT: no such file or directory, stat '***\gitbook-plugin-fontsettings\fontsettings.js'
     

     google 之后在这里找到了解决方法。

     找到文件 copyPluginAssets.js（题外话，推荐使用 everything 找电脑上位置不确定的文件），将 112 行的 confirm: true 改为 confirm: false。再执行一次命令 gitbook serve 就可以再浏览器中预览了。

4. 将本地的 gitbook 提交到云端

   将本地的 gitbook 工程存储到 github，假设存储在名为 mygitbook 的仓库中。

   访问 gitbook 官网，注册一个账号，创建一个 space。

   

   开启 github 插件，允许从 github 同步文件。

   

   选择从仓库 mygitbook 同步文件，稍等一会儿就会看到与本地一致的效果。

   

5. 获得访问云端 gitbook 的外链

   假设你你账户的名称为 eftales，你创建的 space 的名字为 essay，则你的外链为：https://eftales.gitbook.io/essay/。

   其余同理。

参考

https://blankj.com/gitbook/gitbook/

http://www.chengweiyang.cn/gitbook/basic-usage/README.html