Mac 下 GitBook 的安装与使用

一、GitBook 简介

  • GitBook 是一个基于Node.js的命令行工具,我们可以通过 GitHub/Git 和 Markdown 构建出精美的电子书(如:GitBook帮助文档)。而且,GitBook 支持使用多种语言构建书籍.
  • GitBook 支持输出多种文档格式:

    • 静态站点:GitBook 默认输出该种格式,生成的静态站点可直接托管搭载在Github Pages服务上;
    • PDF:需要安装 ebook-convert;(网上也有说需要安装 gitbook-pdf 依赖,但即使在翻墙的情况下安装过程也会出现连接失败)
    • eBook:需要安装 ebook-convert;
    • 单HTML网页:支持将内容输出为单页的 HTML,不过一般用在将电子书格式转换为 PDF 或 eBook 的中间过程;
    • JSON:一般用于电子书的调试或元数据提取.
  • 相关网址:GitBook 官网    GitBook 的 Github 地址     GitBook帮助文档

二、Mac 下 GitBook 的安装

1、安装 Node.js

GitBook 是基于 Node.js 的命令行工具,因此我们需要先安装 Node.js. 登录 Node.js 官网 http://www.nodejs.org/,下载安装包并安装。安装完成这后,你可以在终端模式下检验一下:

node -v
v5.2.0

看到版本提示,就表示 Node.js 安装成功了.

2、GitBook 安装

  • Gitbook 是从 npm 安装的,终端下执行命令:

    npm install -g gitbook-cli
    
  • 如果因权限问题失败,执行:

    sudo npm install -g gitbook-cli
    
  • 检验是否安装成功:

    gitbook -V
    1.0.1
    

如果显示上述版本信息,表明 GitBook 安装成功基本可以使用了.

3、Calibre 的安装

  • 下载安装: GitBook 转 pdf/epub/mobi 时需要 calibre 的 ebook-convert 组件支持,Calibre 下载地址
  • “Error: Need to install ebook-convert from Calibre”错误:如果在安装成功之后转 PDF 时,出现这种错误,就需要配置一下相关路径:

    export PATH=/Applications/calibre.app/Contents/MacOS:$PATH
    

    在应用程序选中 Calibre,右键“显示包内容“,找到 ebook-convert 的路径,然后替换掉我的(”:$PATH”是结尾).然后查看确认下配置的路径:

    echo $PATH
    

三、GitBook 的使用

GitBook 的使用与 GitHub 类似,每一个 Book 其实就是 Git 的一个仓库.下面以创建一个名为 Test 的 Book 为例,演示 GitBook 的使用.

  1. 去官网 GitBook 注册一个账号.
  2. 在网站创建一个 Book ,起名为 test.
  3. 在本地创建 Book

    mkdir test
    cd test
    touch README.md SUMMARY.md
    git init        //若不与Github交互可直接在空目录下执行gitbook init自动生成README.md SUMMARY.md
    git remote add gitbook https://git.gitbook.com/summerrc/test.git
    git add .
    git commit -m "first commit"
    git push gitbook master
    

    可以看到创建一个 book 就像创建一个 git 仓库一样,可以执行add,commit,push,pull等操作,同样你也可以像github那样与他人协作完成一本 book.

  4. 生成相关格式文件

    • 生成完整的静态 HTML/ebook 并查看:

      • 生成网页,在书目录执行:

        gitbook build
        

        可以看到在书目录下生成了一个 _book 目录,生成的 HTML 网页就在该目录

      • 本机查看网页,在书目录执行:

        gitbook serve
        

        可以看到终端提示在浏览器输入http://localhost:4000查看book

    • 生成PDF:

      gitbook pdf             
      

      可以看到在项目根目录下生成了 book.pdf 文件

    • 生成epub:

      gitbook epub             
      

      可以看到在项目根目录下生成了 book.epub 文件

    • 生成mobi:

      gitbook mobi             
      

      可以看到在项目根目录下生成了 book.mobi 文件

四、其它问题

  • 建议使用GitBook官方的客户端,下载地址
  • 不得不说 GitBook 网站的访问速度简直感人,建议将在 GitBook 创建的 Book 与 Github 的仓库关联,这样我们只需提交内容到 Github 即可,GitBook 的 Book 会被实时同步更新.
  • GitBook官方帮助文档 简直看的感人,有空翻译成中文,试试 GitBook 的多语言支持功能。(好吧,不有空了,就本周内完成吧==)

五、更多问题

想要了解更多可以参考我翻译的 GitBook官方文档中文版.

坚持原创技术分享,您的支持将鼓励我继续创作!

热评文章