作者:泡沫茱_617 | 来源:互联网 | 2023-09-23 14:01
很多开发者都有写技术博客和学习笔记的习惯,当写的文章到一定数量时,一定想用某种方式把它们整理出来吧,或方便自己回顾,或方便他人参考。当然希望这种整理笔记或文章的方式,形式简洁、排版
很多开发者都有写技术博客和学习笔记的习惯,当写的文章到一定数量时,一定想用某种方式把它们整理出来吧,或方便自己回顾,或方便他人参考。
当然希望这种整理笔记或文章的方式,形式简洁、排版优雅最好了,想想,将自己的笔记和文章整理成电子书倒是个非常不错的选择,方便查看,还易于分享。
而在程序员界,用的最多的当属 Gitbook 啦,一款简单而优雅的制作电子书的命令行工具,可以轻松快捷的做成一本电子书,并且可以发布到 gitbook.com 或者 GitHub pages 上,非常方便,也是绝大部分程序员梳理知识体系的首选。
如果你想整理自己的笔记、梳理自己的知识体系,却找不到合适的方式,也不知道如何使用 Gitbook 来制作电子书,那么这篇文章请细看,实验楼会教你如何利用 GitBook 制作电子书。
PS.非程序员也可以看,只要你想做一本自己的电子书。
一、GitBook 介绍
Modern book format and toolchain using Git and Markdown
GitBook 是一个使用 GitHub/Git 和 Markdown 来制作电子书的命令行工具 (Node.js 库)。
另外,有一个网站 gitbook.com 可以帮助用户更好的使用 Gitbook。同时 gitbook.com 还提供了一个桌面编辑器,帮助用户编辑电子书。
Gitbook 与 gitbook.com 的关系类似 Git 和 GitHub,一个是工具,另一个是基于工具创建的网站。
二、开发完成后的效果截图
三、Gitbook 安装
目前有两种方式可以而让你使用 Gitbook 来编辑、发布和管理电子书:
- 本地编辑,然后发布到类似 GitHub pages 的第三方平台;
- 直接使用已有的 gitbook.com 网站。
实验楼上的项目教程呢,对这两种方式都进行了讲解和介绍,在这里呢,我们介绍第二种方式“直接使用已有的 gitbook.com 网站” ,因为这种方式对程序员和非程序员来说都很容易操作。
那么第一种本地安装Gitbook的方法和以及编辑书籍的方式呢,你可以点击这里进行查看。
四、gitbook.com 简介:
gitbook.com 是一个围绕 Gitbook 发行书籍的社区,于 2014 年初创,gitbook.com 提供免费和付费的服务,而且免费账户就可以享受诸多服务,包括:
- 1 本私有书籍;
- 托管不限数量的公开书籍;
- 售卖不限数量的书籍,并分享 80% 的书籍收入;
- 不限数量的协作者;
- 免费的在线书籍编辑器。
要使用 gitbook.com 来托管你的书籍,首先需要注册一个账号。点此注册,登陆 gitbook.com 后,在用户页面,可以管理现有书籍以及创建新的书籍:
创建完成以后,会进入书籍管理页面:
点击 “Edit your book” 按钮,进入一个在线编辑器:
- 中间是编辑区域,使用 Markdown 语法;
- 左上方是章节目录,鼠标右键可以新增章,在上右键可以新增节,托放可以改变顺序;
- 左下方是文件列表,鼠标右键可以新增目录或文件。这里面最必要的是
README.md
和 SUMMARY.md
。前者是书籍的简介,后者是真正决定书籍目录结构的,比如多层次目录结构,需要手动修改 SUMMARY.md
(左上方会立刻呈现效果)。 - 右侧是预览窗口,可以点击 “眼睛图标”关闭/开启预览区域。其实可以关闭左侧区域和右测预览区域,专心写作。
五、发布到 GitHub
我们可以在 GitHub 上创建一个仓库,来管理书籍源码。
注意:
源代码保存到 master 分支,编译出来的静态文件_book
上传到 gh-pages 分支,这样我们就可以通过 GitHub pages 来发布电子书了。
具体操作:
- 登录到Github,创建一个新的仓库,名称我们就命令为 book,这样我就就得到了一个 book 的空仓库;
- 克隆仓库到本地:
git clone git@github.com:USER_NAME/book.git
; - 创建一个新分支:
git checkout -b gh-pages
,注意,分支名必须为 gh-pages ; - 将分支 push 到仓库:
git push -u origin gh-pages
; - 切换到主分支:
git checkout master
。
经过这一步处理,我们已经创建好 gh-pages 分支了,有了这个分支,GitHub 会自动为你分配一个访问网址:http://USERNAME.github.io/book
。
操作到这一步,我们所在目录是在 Code/book/
下,现在我们需要在 Code 目录下保存我们的电子书的静态文件,切换到Code 目录,克隆远程仓库 book 的 gh-pages 分支并保存为 book_build
:
git clone -b gh-pages git@github.com:USERNAME/book.git book-build
然后我们从 Code/book/_book
目录下把编译好的电子书静态文件复制到 Code/book_build
下,执行:
sudo git add .
sudo git commit -m "add e-book static file"
sudo git push
将静态文件 push 到远程仓库 book 的 gh-pages 分支。
然后,等十来分钟的样子,你就可以通过访问网址:http://USERNAME.github.io/book
来访问到你的在线图书了。之后,每次修改之后,都可以将生成的静态文件 copy 到 book-build 目录,再 push 到远程仓库 book 的 gh-pages 分支。
六、Github 集成
我们之前在 gitbook.com 新建了一本电子书,并且把电子书的源码存放在了 GitHub 上。现在,我们可以将 gitbook.com 上的这本电子书与 GitHub 的远程仓库关联起来,我们可以通过向书籍的 GitHub 仓库提交内容来更新书籍。
登陆 gitbook.com 网站,可以看到我们之前创建的电子书,然后点击 “Book Settings” 按钮。
在 “Settings” 栏目中,点击 “GitHub”。
点击 “Select a Repository”,选择我们创建的存放电子书源码的仓库。
确定仓库之后,点击 “Sync” 按钮,同步。
成功!之后,每次在 GitHub 上更新电子书时,都会自动同步到 gitbook.com,并且自动编译成电子书。
七、最后
至此,我们就可以使用发布一本属于自己的电子书籍啦,快来学习吧。