百度已收录

GitBook 是一个基于 Node.js 的命令行工具

  1. 下载 Node.js

  2. 找到对应自己系统的下载,此教程用于centos7

    wget https://nodejs.org/dist/v12.14.1/node-v12.14.1-linux-x64.tar.xz

    • 输入ls有node-v12.14.1-linux-x64.tar.xz文件,下载成功
  3. 解压

    • 解压xz文件

      xz -d node-v12.14.1-linux-x64.tar.xz

    • 如果没有xz,安装命令如下

      yum install xz -y

    • 解压tar文件

      tar xf node-v12.14.1-linux-x64.tar

  4. 配置环境变量

    #######node#######
    export NODE_HOME=/apps/svr/node-v12.14.1/bin export PATH=$PATH:$NODE_HOME

  5. 刷新环境变量配置

    source /etc/profile

  6. 检验node.js是否安装成功

    node -v
    npm -v

  7. 安装 GitBook

    npm install gitbook-cli -g

  8. 检验GitBook是否安装成功

    gitbook -V

  9. 找一个自己要写书的目录

    # 切换到写书目录
    cd /apps/workspace/gitbook_work
    # 初始化目录文件
    gitbook init

  10. 初始化后,在该目录生成如下文件

    • README.md 应该不陌生,就是说明文档
    • SUMMARY.md 其实就是书的章节目录
  11. 接下来,我们输入gitbook serve命令,然后在浏览器地址栏中输入http://localhost:4000便可预览书籍

  12. 运行上述命令后会在书籍的文件夹中生成一个_book文件夹,里面的内容即为生成的 html 文件,我们可以使用下面命令来生成网页而不开启服务器

    gitbook build

  13. GitBook 目录结构及相关文件

  14. SUMMARY.md

    • 这个文件主要决定 GitBook 的章节目录,它通过 Markdown 中的列表语法来表示文件的父子关系

    • 这个配置对应的目录结构如下所示:
  15. GitBook还提供了很多插件,下面以hide-element举例

    npm install gitbook-plugin-hide-element

    • 在书的目录下手动新建book.json文件,添加如下代码,即可隐藏书侧边栏目录的Published by GitBook,本书使用 GitBook 发布,另book.json文件还可以配置很多信息,详细配置请自行百度
      {
      "plugins": [
      "hide-element"
      ],
      "pluginsConfig": {
      "hide-element": {
      "elements": [".gitbook-link"]
      }
      }
      }

    站长的书:预览传送门