1. GitBook概述
1.1 GitBook 有两个含义
1.2 为什么选择GitBook
- 简洁(采用Markdown语法,没有其他渲染,符合记录学习笔记的定位)
- 可在线浏览、可转成电子书(PDF、ePub、Mobi)
- 形成工具使用体系(Git、GitHub、GitHub Pages、GitBook)
- 不怕编写失误(每次提交记录都可追溯)
2. 使用方式
2.1 在线编辑 / GitBook Editor
优点:学习成本基本为0;所见即所得;可以忽略实际的文件结构
缺点:就是大陆人民你懂的缺点…
2.2 Git & Markdown编辑器
- 优点:
增加对于Git、Markdown的熟练度;本地操作无需网络;能掌握实际的文件结构 - 缺点:
问题不大,需要两三通操作来实现网页预览和提交到线上
3. 使用Git & Markdown编辑器 记录学习笔记
3.1 安装 GitBook
- 安装Node.js
- 打开命令行,输入以下命令安装:
npm install gitbook-cli -g
;可通过gitbook -V
(V为大写)命令查看安装版本,如正常显示则安装成功:
3.2 安装Markdown编辑器 Notepad++
3.3 创建GitBook电子书
- 选择或创建合适的空白文件夹
- 通过命令行在该目录下执行
gitbook init
可以查看目录下生成了两个文件:
SUMMARY.md
是电子书的目录文档,电子书的灵魂所在;README.md
的定位是电子书的简介(必须存在,即使删除,之后也会新建)
3.4 开始编写
之所以说SUMMARY.md
是电子书的灵魂,是因为SUMMARY.md
奠定了整个电子书的框架。
所有的章节文档无需手动创建,gitbook init
命令 会根据SUMMARY.md
的内容,自动创建对应的文件以及目录。
3.4.1 编写README.md
可以根据Markdown语法,随意增、删、修改内容,不偏离 本书简介 这个主题就行。
3.4.2 编写SUMMARY.md
填写当前确定的章节以及文件夹分类,执行gitbook init
;如果后续有改动,再重新执行gitbook init
即可(目录中 删去已存在的文件,实际md文件仍会存在,需要手动删除,即该命令只支持增加和修改,不支持删除)。
可以通过使用标题或者水平分割线标识将GitBook目录分为几个不同的部分。
示例:
显示效果:
3.4.3 编写对应的章节
打开目录下对应的章节文件进行编写即可。(Notepad++通过插件Light Explore就能方便地浏览打开生成的章节文件。
3.5 插入图片
3.6 发布到GitBook
3.7 发布到Git Pages
4. 功能拓展及定制
参考: