架构师_程序员_码农网

 找回密码
 注册[Register]

QQ登录

只需一步,快速开始

查看: 4590|回复: 0

GitBook 入门使用教程

[复制链接]
发表于 2018-11-23 14:03:54 | 显示全部楼层 |阅读模式
GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出 HTML、PDF、eBook 等格式的电子书。

安装node.js

在使用gitbook工具之前,电脑需要安装node.js环境,装好以后,可以通过查看版本命令来测试是否安装成功:


安装Gitbook

Gitbook 是用 npm 安装的,命令行:

QQ截图20181123131305.jpg

执行下面的命令,查看 GitBook 版本,以验证安装成功。

安装历史版本

gitbook-cli 可以轻松下载并安装其他版本的GitBook来测试您的书籍:



使用 gitbook ls-remote 会列举可以下载的版本。


Markdown编辑器

这里我们使用Markdown语法作为我们的文档的书写语言,我们需要准备一个Markdown编辑器,市面上我们可以找到很多 Markdown 编辑器,比如 Typora、MacDown、Bear、MarkdownPad、MarkdownX、JetBrains’s IDE(需要安装插件)、Atom、简书、CSDN 以及 GitBook 自家的 GitBook Editor 等等。

我电脑中装有vs code开发工具,vs code默认是支持markdown的,只需要装一个预览插件神器:Markdown Preview Enhanced,所有就使用它了!

QQ截图20181123131924.jpg

朋友推荐的编辑器typora,地址:https://typora.io/

初始化一本书

GitBook可以设置一个样板书:

如果您希望将书籍创建到一个新目录中,可以通过运行 gitbook init ./directory 这样做。

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

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

QQ截图20181123132945.jpg

我对markdown语法也不熟,就随便写几句话吧!




QQ截图20181123133655.jpg

生成静态网页

生成静态网页并运行服务器

以上都会在书籍目录生成 _book。


serve 命令也可以指定端口:




生成时指定gitbook的版本, 本地没有会先下载



列出本地所有的gitbook版本



列出远程可用的gitbook版本



安装对应的gitbook版本



更新到gitbook的最新版本



卸载对应的gitbook版本


指定log的级别



输出错误信息



Summary

GitBook 使用 SUMMARY.md 文件来定义本书的章节和子章节的结构。 SUMMARY.md 文件用于生成本书的目录。

SUMMARY.md 的格式是一个链接列表。链接的标题将作为章节的标题,链接的目标是该章节文件的路径。

向父章节添加嵌套列表将创建子章节。

简单示例:


然后我们回到命令行,在 mybook 文件夹中再次执行 gitbook init 命令。GitBook 会查找 SUMMARY.md 文件中描述的目录和文件,如果没有则会将其创建

输出 PDF、ePub或者mobi文件

如果要生成pdf版本,则运行gitbook pdf即可,同理,如果是导出epub格式,则gitbook epub,如果是mobi格式,则gitbook mobi即可。



如果是要导出PDF,ePub或者mobi格式的电子书时,需要安装Calibre电子书阅读/管理器和命令行工具,不然可能会报错“EbookError: Error during ebook generation: 'ebook-convert'”。

GitBook 特殊文件的功能:

文件
描述
book.json配置数据 (optional)
README.md电子书的前言或简介 (required)
SUMMARY.md电子书目录 (optional)
GLOSSARY.md词汇/注释术语列表 (optional)
Gitbook 常规设置

GitBook 允许您使用灵活的配置自定义您的电子书。

这些选项在 book.json 文件中指定。对于不熟悉 JSON 语法的作者,您可以使用 JSONlint 等工具验证语法。

变量
描述
root包含所有图书文件的根文件夹的路径,除了 book.json
structure指定自述文件,摘要,词汇表等的路径
title您的书名,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。
descrip{过滤}tion您的书籍的描述,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。
author作者名。在GitBook.com上,这个字段是预填的。
isbn国际标准书号 ISBN
language本书的语言类型 —— ISO code 。默认值是 en
direction文本阅读顺序。可以是 rtl (从右向左)或 ltr (从左向右),默认值依赖于 language 的值。
gitbook应该使用的GitBook版本。使用SemVer规范,并接受类似于 “> = 3.0.0” 的条件。





上一篇:有没有抢购博纳云码子的
下一篇:用vscode写markdown的正确姿势
码农网,只发表在实践过程中,遇到的技术难题,不误导他人。
您需要登录后才可以回帖 登录 | 注册[Register]

本版积分规则

免责声明:
码农网所发布的一切软件、编程资料或者文章仅限用于学习和研究目的;不得将上述内容用于商业或者非法用途,否则,一切后果请用户自负。本站信息来自网络,版权争议与本站无关。您必须在下载后的24个小时之内,从您的电脑中彻底删除上述内容。如果您喜欢该程序,请支持正版软件,购买注册,得到更好的正版服务。如有侵权请邮件与我们联系处理。

Mail To:help@itsvse.com

QQ|手机版|小黑屋|架构师 ( 鲁ICP备14021824号-2 )|网站地图

GMT+8, 2024-3-29 14:32

Powered by Discuz! X3.4

Copyright © 2001-2021, Tencent Cloud.

快速回复 返回顶部 返回列表