Gitbook使用教程

Gitbook使用教程

1.Gitbook简介

GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出 HTML、PDF、eBook 等格式的电子书。

2.Node.js安装

因为 GitBook 是基于 Node.js,所以我们首先需要安装 Node.js(下载地址:http://nodejs.cn/download/),找到对应平台的版本安装即可。
安装完成之后,你可以使用下面的命令来检验是否安装成功。

node -v

3.Gitbook安装

现在安装 Node.js 都会默认安装 npm(node 包管理工具),所以我们不用单独安装 npm,打开命令行,执行以下命令安装 GitBook:

npm install -g gitbook-cli -g

4.node高版本使用gitbook报错解决方案

参考:(http://wlphp.com/m/?post=369)

5.Gitbook使用

想象一下,现在你准备构建一本书籍,你在硬盘上新建了一个叫 mybook 的文件夹,按照以前的做法,你会新建一个 Word 文档,写上标题,然后开始巴滋巴滋地笔耕。但是现在有了 GitBook,你首先要做的是在 mybook 文件夹下执行以下命令:

gitbook init

执行完后,你会看到多了两个文件 —— README.md 和 SUMMARY.md,它们的作用如下:

README.md —— 书籍的介绍写在这个文件里
SUMMARY.md —— 书籍的目录结构在这里配置

我们执行 gitbook serve 来预览这本书籍,执行命令后会对 Markdown 格式的文档进行转换,默认转换为 html 格式,最后提示 “Serving book on http://localhost:4000”

6.book.json

主要存放配置信息

//我主要放了要加载的插件列表
{
    “plugins”: [
        “expandable-chapters”
    ]
}

配置说明

变量 描述
root 包含所有图书文件的根文件夹的路径,除了 book.json
structure 指定自述文件,摘要,词汇表等的路径
title 本文的书名,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。
description 您的书籍的描述,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。
author 作者名。在GitBook.com上,这个字段是预填的。
isbn 国际标准书号 ISBN
language 本书的语言类型 —— ISO code 。默认值是 en
direction 文本阅读顺序。可以是 rtl (从右向左)或 ltr (从左向右),默认值依赖于 language 的值。
gitbook 应该使用的GitBook版本,并接受类似于 >=3.0.0 的条件。
links 在左侧导航栏添加链接信息
plugins 要加载的插件列表(官网插件列表)
pluginsConfig 插件的配置

7.生成电子书

1.安装ebook-convert

安装 ebook-convert(针对 Windows 用户)
ebook-convert 是能够自由转化格式的一个命令行工具,已经包含在 calibre 软件里面了。

(1)安装 calibre 软件。calibre 的官网如下:(我们可以去官网下载安装)

https://calibre-ebook.com/
(2)在终端输入如下命令,验证 ebook-convert 是否能正常使用:

ebook-convert --version
如果输入上面的命令后提示错误,说明你还需要将 calibre 的安装目录添加到系统的环境变量中。

2.安装配置环境变量( https://www.cnblogs.com/gobyte/p/10953081.html)

3.导出电子书

(1)本地预览电子书:

gitbook serve

执行上方命令后,工具会对项目里的 Markdown 格式的文件进行转换,默认转换为 html 格式,最后提示 Serving book on http://localhost:4000。

我们打开浏览器输入http://localhost:4000,预览一下电子书的效果:

(2)制作并导出电子书。

生成 PDF 格式的电子书:(PDF 是最常见的文档格式)

gitbook pdf

生成 epub 格式的电子书:(epub 是最常见、最通用的电子书格式)

gitbook epub

生成 mobi 格式的电子书:(mobi 格式可以在 kindle 中打开)

gitbook mobi

上面这三种格式的电子书生成之后,项目里会看到这三个新增的文件

你可能感兴趣的:(前端,vscode,vue.js,node.js)