在本地看GitHub书籍

迫使我想在本地查看GitHub文档的原因

  1. 希望能离线看GitHub的书籍(我不能保证我每天24小时都有网络)
  2. 使用Typora等markdown软件查看的时候打开章节会弹多一个窗口,个人希望是一个窗口,且可返回,目前我未发现能满足这个需求的markdown软件

注意:
因各地网络原因,某些命令的安装可能会失败,这种情况尝试多安装几次即可。若实在安装不上,尝试修改nodejs的源为淘宝的源,网上有相关的文章,此处不做赘述。再安装不上,请另想办法

以Ubuntu为例

1、安装calibre

sudo apt install calibre

2、安装nodejs

sudo apt install nodejs

3、安装gitbook

sudo npm install gitbook-cli

4、安装插件到书籍所在的目录

cd ~/book				# 假设书籍clone下来的目录在~/book
gitbook install			# 安装插件到当前目录

注:1~4步骤需要联网,以下步骤不需要联网
5、开始转换格式为pdf

cd ~/book				# 假设书籍clone下来的目录在~/book
gitbook build
gitbook pdf				# gitbook epub可以转换格式为epub、gitbook mobi可以转换格式为mobi

执行完上面的命令后,可看到在当前目录有个book.pdf
6、若想直接在浏览器查看电子书,可使用以下命令

cd ~/book				# 假设书籍clone下来的目录在~/book
gitbook serve .			# 此步骤若成功,会输出结果"Serving book on http://localhost:4000"

执行完上述步骤之后,在浏览器打开http://localhost:4000即可访问书籍,或在浏览器打开http://IP:4000,其中 IP是代指指执行命令**gitbook serve .**那台电脑的IP地址

注:若只需要在浏览器查看不需要转换格式,则进行1、2、3、4、6步骤即可

以Windows为例

1、安装nodejscalibre
2、在cmd命令行安装gitbook

npm install gitbook-cli

3、其余步骤跟Ubuntu的4~6步骤相似,不多做赘述,值得注意的是,Windows转换书籍可能会失败,若失败,可以尝试在Ubuntu中转换格式

=============== 以下是2020.04.30更新 ===============
因gitbook-cli这个工具实在是太久没有被维护了,虽然很好用,有些情况实在是不能满足需求,因此,我换过多种方法在本地看GitHub的书籍,中间还是遇到各种不满足,
1、在电脑安装一个gitea,通过把GitHub的书籍上传到本地的gitea服务器,在git服务器网页端看,而后发现部分文字会去掉一些空格,看起来就像两个单词黏在一起,很是别扭,且由于我看的大多是编程类的书籍,所以这个问题带来格外多的困扰
2、使用pandoc转换书籍的格式,发现无法处理markdown中嵌入的部分html代码,看起来格外难看,于是又放弃了
3、使用gitlab或者gitee(码云),gitlab相对GitHub,速度还是可以的,gitee更是阿里的一个产品,国内使用还是不错的,如果单纯只是嫌弃GitHub太慢了,在这两个平台上注册账号后在上面看书也是个不错的选择
4、若执意想要离线观看,推荐虚拟机+gitlab(gitlab官方有docker项目,也可以直接使用,但官方提示gitlab docker对windows的支持并不算太好,有些功能无法支持,但本人实际体验,基本的功能还是能用的 ),搭建一个自己的gitlab服务器,我使用的是CentOS7+gitlab,CentOS选择最小安装(还有安装一个dns服务器用来解析域名),对着gitlab官网给的步骤安装gitlab服务器即可,我就是采取这种方法(离线的忠实粉丝,毕竟只有离线的时候自己才有绝对的控制权),因为centOS最小安装基本不占用什么cpu,装完gitlab后,整个虚拟机占用磁盘也就不到4个G,gitlab对代码的着色也挺不错的,目前对该方式感到非常舒服~~下图是部分看书时的截图
在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/weixin_35599364/article/details/104011512