制作GitBook电子书(入门)

如果(喜欢编程的)你经常做笔记,或者写一些文档类东西的话,不妨尝尝这款工具:GitBook
简单来说,GitBook就是一个写作和发布的平台,我们写的东西回在上面输出成一个静态的在线网页。
有了托管平台,我们还需要一种现在非常流行的标记语言来对我们写的文字进行标记排版:Markdown

Markdown是一种轻量级的标记语言,创始人为约翰·格鲁伯(英语:John Gruber)。它允许人们"使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档"。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。
wikipedia

markdown对我而言最大的优点就是,在边打字边标记排版时可以完全脱离鼠标,不需要在键鼠之间来回切换。这种文字的标记的方式也是markdown与别的文字标记工具(如常用的Office Word)之间最大的差别。
正如上面维基百科介绍,这是一种纯文本格式的标记语言,既然是一门语言,所以它也有自己的语法,markdown的语法特别简单,你可能只需要花几分钟就可以轻松入门。网上有很多已经整理好了的语法集合,记住几个简单常用的语法就已经够了。
废话不多说,下面开始搭建Gitbook+Markdown环境。

安装


安装Node.js

由于Gitbook是基于Node.js的,所以要先去Node.js官网下载安装Node.js(下载地址),根据自己电脑的情况选择适合的安装包下载安装。
(安装过程就是一路next,暂可不表)

安装Gitbook

打开终端,输入命令:

npm install gitbook-cli -g

查看安装的Gitbook的版本或检查Gitbook是否已安装:

gitbook -V

Alt

安装Typora

到这里Gitbook环境已安装完成,但是markdown只是一种语法,它只有在支持markdown语法的编辑器里才有效果。在看了网上众多人推荐的编辑器以及自己亲自体验了几款之后,我个人推荐使用Typora(下载地址)。

它的特点是:

  • 免费
  • 支持多系统
  • 实时渲染
  • 界面简洁
  • 支持比较流行的markdown语法的扩展(markdown有标准语法和扩展语法之分,标准语法所有编辑器都适用,扩展语法要看不同的编辑器)

如果Typora不合胃口,你也可以尝尝

  • Macdown(支持macOS 官网)
  • MarkdownPad(支持windows 官网)
  • MarkdownX(支持Android)

(Typora也是直接安装就好,没有什么需要注意的)

创建目录&写入内容


我们先在桌面是创建一个空文件夹,命名"gitbook"。然后打开终端,路径要设置到这个文件夹,输入以下命令来进行目录初始化:

gitbook init

就会显示下图:

制作GitBook电子书(入门)_第1张图片

打开gitbook文件夹,发现在文件夹里多了两个文件,README.md,SUMMARY.md;

制作GitBook电子书(入门)_第2张图片

README就是说明文档,里面可以是对该本书的介绍&说明;SUMMARY是这本书的章节目录,其作用就是可以直接跳转到你指定的章节。

用Typora打开两个文件,其默认内容分别是这样的:

制作GitBook电子书(入门)_第3张图片

制作GitBook电子书(入门)_第4张图片

下面我们可以直接在Typora这个编辑器下给gitbook文件夹再创建几个 .md 格式的文件,在README文件里写下一句话,并在SUMMARY文件里使用Markdown语法将刚建的几个文件都收录到该目录下,如下图:

制作GitBook电子书(入门)_第5张图片

制作GitBook电子书(入门)_第6张图片

这本"小书"就框架差不多完成了,从SUMMARY中看得出来,它一共有三个章节,分别是"Introduction",“衣”,“食”。

下面来本地预览一下。

本地预览


打开终端,重新设置上面的路径并输入:

gitbook init

接着再输入:

gitbook serve

稍等几秒,出现如下图:

制作GitBook电子书(入门)_第7张图片

复制上面的网址粘贴到浏览器地址搜索栏里,就可以本地预览到你的电子书了:

制作GitBook电子书(入门)_第8张图片

需要注意的是,这个页面是gitbook启动的一个 4000 端口用于给你本地预览电子书的静态网站,只有你自己的电脑可以预览,别的设备是预览不到的。当你在终端按了 CTRL+C 后退出预览,在刚刚生成的静态网站里也就看不到你的电子书了。




Code & Love

你可能感兴趣的:(制作GitBook电子书(入门))