gitbook——自己写本书

1,130 阅读4分钟

gitbook——自己写本书

有群友提议我可以出一些计算机组成原理的内容,等我毕设结束,一定给安排上,不过考虑到计组的庞大内容,所以如何写是一个问题,于是我想到了gitbook,本篇稍微介绍一下gitbook

什么是gitbook

各大高校的计科人一定有所耳闻:

清华大学OS实验指导书

南京大学计算机系统基础课程

gitbook做知识体系分享可真的是很方便吧。

gitbook有什么用

首先应该想到的就是像上面说的那样,作为分享知识的手记,这不比某些云笔记,一点也都差不多嘛~

当然由于其显著的章节分明的特点,也可以来写小说呀(讨厌被催稿的笔友可以考虑一下)

官方文档说明可以设置书本的可见性,所以可以用这个来写日记,只要设计成私密模式即可(写本子上的那叫日记嘛,日记能写本子上嘛) gitbook可见性

由于其支持个人和组织的使用,结合上面说的可见性设置,也就可以为小团体使用!!

没错,你想到什么?

对没错,是女朋友,你们可以一起书写回忆,多年后打印一本书送给对方,是不是有点感动?

哦读者都没有女朋友啊 也可以用来写一手自己的人物传记噢

PS:如果你项目够多的话,可以考虑给每个项目的简介写在gitbook

如何使用gitbook

注册账号

官网:https://app.gitbook.com/join

下载

哦为什么还要下载?

github上gitbook的简介

如图,gitbook是一个命令行工具——使用git/github去构建一本漂亮书的工具。

不下载当然是可以的,在线编辑就好啦,不过为了水文,我自然要写一下本地的编辑方式(而且本地有备份我才心安)

下载方式等一系列教程在官方文档都有写很详细,我就随便写写啦

我的电脑系统是Ubuntu20.10,Windows的同学仅供参考咯

  1. 环境要求

    NodeJS (v4.0.0 and above is recommended) Windows, Linux, Unix, or Mac OS X

  2. 安装npm

    apt install npm
    
  3. 安装gitbook

    npm install gitbook-cli -g
    

    Ubuntu安装gitbook

使用

好了下面才是正文

使用的话像git一样,要初始化一个仓库,这里是初始化一本书——gitbook

在喜欢的文件夹下进行即可:

  1. 初始化一本书

    gitbook init
    

    gitbook初始化

  2. 学会markdown

    此处省略两千字

  3. 看看效果 上面初始化的时候可以看到已经建了几个文件,其中README.md文件是最打开网页时默认看到的那一页,SUMMARY.md也就是你的目录了。

    看看里面写的什么:

    README.md文件

    好吧只写了一句话,那么我们加点,变成这样:

    预览一下

    在你的书的目录下,执行gitbook serve,在浏览器中输入http://localhost:4000便可预览书籍。

    执行gitbook build,只生成网页不开启服务器。

    区别在于:开启服务器可以打开http://localhost:4000预览书籍,不开启服务器可以双击生成的网页文件预览书籍。我们选择第一种,效果如下: 浏览器中的效果 至于其中的目录嘛,在另一个文件里啦~

添加文件和章节

由于一般书籍的章节比较多,所以建议每章都建一个文件夹,每章的内容就放在各自的文件夹里。然后再把对应章节内容的相对路径写在SUMMARY.md里就可啦,比如我要写一个“计算机组成原理”的内容,文件夹叫PC,添加一篇内容叫welcome.md,照猫画虎修改SUMMARY.md,添加如下内容:

我们再访问一下试试看:

Bingo,新章节添加成功啦~

好了可以开始写书了

部署到服务器

差点忘了说了,网上别的教程可能都是推荐使用github做托管的教程,但其实gitbook有自带的仓库,在其文档中就有写到:

按照其认证的教程,我们在注册完账号以后,还需要知道一个API,获取方式如下:

在账号出选择设置(setting),选择API Token,并且起个名字,目的是为了识别不同的机器,以便我们换了机器只需要添加Token就可以多端写书了。

然后编辑主目录下的.netrc文件()

其他

其实上面只是gitbook的皮毛而已,gitbook的可玩性还是极高的,比如插件

插件的配置以及你的书的样式配置,都可以在一个json文件中配置

还可以转换成不同的电子书版本

如果你想和万千开发者一起写一本书,也可以迁移到github

至于自定义域名和权限设置等,参考官方文档自己摸索一下啦

参考内容

chrisniael.gitbooks.io/gitbook-doc… github.com/GitbookIO/g…

最后,点个关注不迷路

公众号:孟游先生的旅游笔记