GitBook 是一个基于 Node.js 的命令行工具,可使用它来制作精美的电子书。gitbook简洁而且高效,能够用一种结构化的方式组织文章或者笔记,所以不管是学习的输入还是撰写文章的输出,gitbook都不失为一个很好的工具。

网上关于如何安装gitbook的文章有很多,此处不进行总结了。

为什么用Typora?

Typora可以支持实时预览,比起印象笔记等分屏的markdown写作工具,Typora这种所见即所得的极简给做笔记或者写作带来的体验感是非常强的。Typora的大部分语言都是传统markdown,使用Typora在官网下载对应版本即可 。

emoji的使用方法,这个我之前不知道,是无意中触发的:

只要用:emoji-name:的形式就可以插入emoji,通常一个冒号后面加字母就会自动提示emoji了。

:accept::clinking_glasses::v::ok::zap:

gitbook 常用命令

1.gitbook init

这个命令会在指定文件夹创建README.md和SUMMARY.md。

2.gitbook build

运行该命令后会在书籍的文件夹中生成一个 _book 文件夹, 里面的内容即为生成的 html 文件,可以将这个文件发布自己到github的仓库中,可以作为项目的文档或者其他笔记等,使用nameofUser.github.io/nameofRepository域名就可以访问到在线笔记。

注意如果是一个有其他文件的仓库的话,需要在git中创建docs分支,然后将_book的内容传入该仓库的该分支中才能够访问。

3.gitbook serve

这一命令能够让我们在浏览器预览gitbook,通常能够在http://localhost:4000 预览。

常用插件

gitbook支持很多插件,能够更方便地帮助你使用gitbook。插件安装时需要在gitbook所在根目录下新建book.json, 并按照下面的配置进行修改或创建,最后使用gitbook install命令将对应的node_modules下载。

显示文章目录:toc

一般来说如果想要显示文章目录的话,在Typora中可以在文章最开始加入[toc],Typora就能够自动生成对应目录,但这个目录无法在gitbook中显示,这个插件让文档能够插入目录,在浏览器显示时也能够看见目录。

1
2
3
4
5
6
7
8
9
10
11
{
"plugins" : [
"toc",
],
"pluginsConfig": {
"toc": {
"addClass": true,
"className": "toc"
}
}
}

需要目录时须在文章开始添加<!-- toc -->,这样才会显示目录。

总目录折叠:expandable-chapters

这个插件使目录具有折叠功能。

1
2
3
4
5
{
"plugins" : [
"expandable-chapters"
]
}

!这里将不断继续更新 !