首页 > 技术文章 > Gitbook详解(一)-介绍和安装详解

jiangming-blogs 2021-04-10 22:02 原文

1. 简介

Gitbook 是什么?其实用一句话就可以概括,它是一个能将使用 Markown 语法的 md 格式文档,快速制作成各种格式电子书的工具。

常被用于编写文档或者电子书,特点是方便简洁,易于使用。只要熟悉轻量级标记语法的 Markdown 语法,就能使用Gitbook来制作各种格式的电子书。接下来笔者就来分享一下自己使用 Gitbook 的方法和经验,会分类来介绍,感兴趣的可以关注笔者关于 Gitbook 这个系列的文章。

系列文章快捷导航:

  1. Gitbook详解(一)-介绍和安装详解
  2. Gitbook详解(二)-命令行的使用
  3. Gitbook详解(三)-目录结构详解
  4. Gitbook详解(四)-配置和说明详解
  5. Gitbook详解(五)-插件的配置和使用详解
  6. Gitbook详解(六)-导出电子书详解
  7. Gitbook详解(七)-Markdown编辑器推荐
  8. Gitbook详解(八)-发布书籍

本系列在线书籍导航:

  1. 在线访问教程网站1: https://jiangminggithub.github.io/gitbook/

  2. 在线访问教程网站2: https://jiangming_gitee.gitee.io/gitbook/

2. 环境准备

2.1 下载和安装 Node.js

进入上面网站进入选择相关平台下载对应的版本的 Node.js 方法或者安装包,一种是官网根据不同的平台对应的命令来安装,还有一种是下载二进制安装包(笔者推荐方法),进行环境变量配置,本文将介绍笔者的环境安装 Node.js,笔者使用的是Linux Ubuntu环境,使用二进制安装包来安装。

注意: 基于截止到目前的 Gitbook V3.2.3版本,需要使用NodeJs的v10+版本,否则会产生各种报错。
推荐使用:node-v10.24.0-linux-x64

下载 node-v10.24.0-linux-x64 版本的压缩包后,解压到特定的目录,进行环境变量配置。

执行 vim ~/.profile 或者 vim ~/.bashrc 后添加下面的环境变量配置

$ vim ~/.profile
export DART_HOME=TargetPath/node-v10.24.0-linux-x64
export PATH=${DART_HOME}/bin:$PATH

安装完成之后,可以通过下面的命令来验证一下 Node.js 是否安装成功。

$ node -v                                                
v10.24.0

2.2 安装 ebook-concert 依赖

ebook-concert 主要用于生成 PDF、eBook,Mobi 等格式的电子书,具体各平台的下载安装参考官网:https://calibre-ebook.com/download

这里我是使用的Ubuntu平台,执行下面的命令即可:

sudo -v && wget -nv -O- https://download.calibre-ebook.com/linux-installer.sh | sudo sh /dev/stdin

安装完成之后,可以通过下面的命令来验证一下 ebook-concert 是否安装成功。

$ ebook-convert --version
ebook-convert (calibre 5.13.0)
Created by: Kovid Goyal <kovid@kovidgoyal.net>

3. 安装 gitbook-cli

执行安装命令, 参考:https://www.npmjs.com/package/gitbook

$ npm config set registry http://registry.npm.taobao.org   // 可选,设置一下淘宝镜像
$ npm install gitbook-cli -g

安装完成之后,可以通过下面的命令来验证一下 Gitbook 是否安装成功。

$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

4. 相关概述

  1. 看完上面的介绍,是不是知道了 Gitbook 是什么,主要用于做什么了?其实就是将我们的书写的文章生成对应格式的电子书,方便分享大家浏览,比如生成pdf给其他人查看相关的内容,或者生成静态 HTML,发布到网站服务器,可以通过在线电子书的方式分享给更多的人。当然您现在浏览的本书就是使用 Gitbook 进行制作和发布的。

  2. 总之,Gitbook 就是一个电子书生成工具,类似与 Git ,Git 是一个代码仓库管理工具,用于管理代码文件,并且可以生成代码的变更记录,同时具备上传这些文件和变更记录到指定的服务器。那么同理,我们也可以结合 Gitbook 和 Git 来管理我们的文档和生成的电子书文件。当然,本书主要介绍 Gitbook,关于Git 的相关知识,可以参考其他相关的教程。

  3. 和与Git 工具对应的 Github 仓库一样,Gitbook 也有一个官方的仓库(可以在线编辑制作),可以上传我们的电子书的文件,不过在国内貌似部分用户访问不了,但是也没有关系,因为大多数情况主要还是利用这个工具生成的对应的格式电子书进行分享或者发布。

5. 相关网站参考

  1. Gitbook 项目官网:https://www.gitbook.com
  2. Gitbook 项目GitHub:https://github.com/GitbookIO/gitbook
  3. Npm Toolchain:https://www.npmjs.com/
  4. ebook-concert:https://calibre-ebook.com

好了,到此就完成了 Ubuntu 平台的 Gitbook 的安装了,后续的文章会详细介绍关于 Gitbook 的相关使用教程,以及部署自己的在线电子书,敬请关注!

推荐阅读