终端工具

首先说明gitbook-cli和GitBook是两个软件

  • gitboo-cli

    GitBook 的命令行工具

    • 用于安装和管理 GitBook 版本，会自动安装更新所需版本
    • 通过gitbook-cli安装的GitBook默认在~/.gitbook目录可设置GITBOOK_DIR环境变量来指定安装目录

  • GitBook命令行工具

    可借助 GitHub/Git 和 Markdown 或 AsciiDoc 来编写样式美观的书籍

gitbook-cli

  • 安装

    • $ npm install -g gitbook-cli

  • 使用

    • $ gitbook --help输出 gitbook-cli 的帮助信息
    • $ gitbook fetch 标签/版本号安装指定版本的 gitbook
      • $ gitbook fetch beta安装pre-release版本
    • $ gitbook ls列出本地所有版本的gitbook
    • $ gitbook ls-remote列出远程所有版本的gitbook
    • $ gitbook update更新最新版本的gitbook
    • $ gitbook uninstall 2.0.1卸载对应版本的gitbook

gitbook

仅安装 gitbook-cli 而未安装 GitBook，如果执行gitbook命令，会自动调用gitbook-cli工具来安装gitbook

  • 安装

    • $ gitbook fetch 标签/版本号通过gitbook-cli安装指定版本

  • 使用

    • $ gitbook -h列出gitbook所有的命令
    • $ gitbook init初始化生成必须文件README.md、SUMMARY.md，并根据SUMMARY生成目录结构
    • $ gitbook build：在_book 文件夹，生成静态网页
      • --gitbook=2.0.1指定gitbook版本生成, 本地没有会先下载
      • --log=debug指定log的级别
      • --debug输出错误信息
    • $ gitbook serve生成静态网页并运行服务在http://localhost:4000/
    • $ gitbook install安装插件