GitBook入门：使用Markdown语法做笔记

Posted 2021-05-27 生医小R

一直以来我都在对做笔记的方式进行探索。总结下来差不多就是手写纸质笔记-OneNote笔记-Notability手写电子笔记-OneNote+手写结合这段历程。我认为笔记的功能包含这几个方面：帮助构建知识体系；加深对现学知识的理解和记忆；便于日后查阅和复习。所以对于笔记软件的选择，我更倾向于传统“笔记本”的模式（Q：那为什么不直接用笔记本做手写笔记呢？A：因为本人打字速度很快，打字做笔记能比手写快得多）。之前我选择用OneNote也是看中了OneNote的笔记本-页面这个模式。但是OneNote的缺点也挺明显，比如老生常谈的同步问题，以及Office系列的排版问题。这些问题导致我不太能跨平台做笔记，也会因为排版而没办法专注于知识的“输入”。而GitBook这种更类似于Book的模式更让我喜欢，包括前言（readme文件）、目录（summary文件）这些。对于我来说一门学科和一个章节的引言是比较重要的，这些文字对于我来说不能算作具体的知识点，但是可以引导一门学科或者某一个章节的学习，在OneNote里面没办法很好的体现出这一点，但是在GitBook里就可以比较清晰地显示出来了。以及Markdown文件相当于笔记的页面，它标题的构建方式让我觉得更有层次感。而OneNote里使用制表符Tab键的缩进会让人不知道某一个知识点到底属于哪一个层级，表格无限嵌套和页面的无限扩张我也不是很喜欢，在正常页面大小下经常会把我想放在一起的东西给分开，而要是缩小页面我就看不清字了。好了，说着这么多为什么我选择GitBook，接下来进入正题，我们如何用GitBook组织以Markdown文件构建的笔记本。

在这篇文章里我只会介绍简单的操作，如何构建一本书，但具体的原理其实我也不太明白，以及一些复杂的操作我也在慢慢地摸索。如果大家有一些什么好的Tips也欢迎沟通。

---

网页版GitBook的使用

网页版GitBook的操作很简单，进入网页https://www.gitbook.com/，然后注册账号，进入个人页面后Create Space就可以了。因为这种方法需要登陆网页，不能在线下进行编辑，经常还需要科学上网，比较麻烦。所以这里我就不过多介绍这种方式编写书籍的方法了。

Node.js和GitBook的安装

安装Node.js的时候一般会自动安装npm（node包管理工具），这是打开命令提示符cmd，输入：

npm install g- gitbook

这样就安装好了gitbook。为了检验gitbook是否完成安装，接着在cmd里写入

gitbook -v

就可以了。如果完成安装，则会显示gitbook的版本号。

创建一本书籍

现在新建一个文件夹，并且在该文件夹下执行下述命令：

gitbook init

这时该文件夹下会多出两个文件，分别是“README.md”和“SUMMARY.md”文件。README.md文件我在前文介绍过，它相当于一本书的前言或者介绍，而SUMMARY.md文件则是这本书的目录，通过这个文件配置这本书的章节编排。

目录的简单配置

目录的配置依赖于SUMMARY.md文件。现在我们打开它（可以使用记事本，也可以使用markdown文件编辑器Typora或者VSCode，我们后文再说），编辑我们这本书的目录。以我微生物的笔记本为例，我截取一段我的笔记章节，它对应的代码是这样的：

# Summary
* [Introduction](README.md)* [Part I Introduction to Microbiology](pt1/README.md) * [Microbes and Microbiology](pt1/pt1-1.md) * [Microbial Structure](pt1/pt1-2.md) * [Microbial Metabolism](pt1/pt1-3.md) * [Microbial Nutrition and Growth](pt1/pt1-4.md)    * [Microbial Growth](pt1/pt1-5.md)

编辑好这段代码（也就是配置好这个章节）之后，重新对这个文件夹执行

gitbook init

之后这个文件夹里就会创建你在SUMMARY.md中描述的文件夹和文件，然后我们就可以编辑Markdown文档来写我们的笔记了。

Markdown语法

接下来我来介绍一下基本的Markdown语法。

标题：

# 一级标题## 二级标题### 三级标题#### 四级标题##### 五级标题###### 六级标题

Markdown语法只有六级标题，不过对于一个页面来说六级标题已经绰绰有余。预览如下：

强调语法：文本的加粗、斜体、下划线和删除线

*斜体***加粗*****粗斜体***<u>下划线</u>~~删除线~~

预览如下：

表格：

Abnormally | Mechanisms-- | --hypokalaemia | vomiting, use of diuretics and laxativeshyponatraemia | water loading to increase weight before clinic visits

预览如下：

关于表格的语法其实还有，其中包括表格的对齐方式（左对齐、右对齐、居中对齐），以后有机会再进一步细讲。

代码：

`单行代码`
```代码块```

预览如下：

列表：列表分为无序列表和有序列表

- 无序列表1- 无序列表2- 无序列表3
1. 有序列表12. 有序列表23. 有序列表3

预览如下：

引用：

> 引用内容

预览如下：

此外还有分割线、超链接和图片，代码分别是：

---[链接名称](URL)![图片名称](图片地址)

Markdown文件的编辑器

Markdown文件有很多编辑器，在这里我们选择几个常见的进行简单的说明。

记事本：没什么好说的，可以直接通过编辑代码来编辑文档。

Typora：一个最为常见的Markdown编辑器，页面简洁，并且操作方便，很多语法不需要通过敲代码来实现而是简单地点鼠标就行了。是一个比较完美的编辑器，只是代码页和预览页是分离的，而且写长文的时候会卡顿。

VSCode：可以通过一些插件来实现markdown文档的实时渲染，画面美观且可以实现左右分屏，是我本人正在使用的一款markdown编辑软件。

Markdown文件的预览和导出

对该文件夹执行下述命令：

gitbook serve

然后在浏览器里打开localhost:4000即可预览这个gitbook书籍。

对该文件夹执行下述命令：

gitbook pdf

然后一个pdf文件就是出现在该文件夹中，即我们这本书pdf的导出格式。

此外我们还可以导出为epub、mobi等格式，在此不再赘述了。

同步

市面上网盘有很多，比如百度、OneDrive等。对于Gitbook和Markdown文档我更倾向于坚果云同步，在手机上可以下载“坚果云”和“坚果云Markdown”app对Markdown文件进行编辑和管理。

---

说到这里大家其实就可以进行一本GitBook书籍的编辑了。但是这篇文章里也有很多东西没有讲，比如book.json文件的配置，导出pdf格式的设置，好用的VSCode插件等，有的东西我也没完全弄懂。如果日后有机会我会更加深入地介绍GitBook的用法。

这篇文章就写到这里，感谢大家的阅读和支持！