如何在本地搭建gitbook

介绍

gitbook更加适用于书写使用手册,不太适合书写一些博客和总结,所以笔者最近在做一些迁移的工作,将之前gitbook上的内容迁移到当前的博客上。

但是gitbook对于我们的工作还是有适用的地方的。所以在此介绍一下如何本地安装gitbook。

先决条件

安装nodejs是先决条件,因为我们需要npm去下载gitbook。

在mac电脑上,有brew工具的可以直接下载:
$brew search nodejs 搜索包仓库中是否有nodejs
$brew install nodejs 有就可以直接下载

你也可以选择去官网上下载最新的nodejs压缩包,解压配置环境变量后即可使用。

关于brew,读者可以参考简书进行安装。

搭建

这里默认大家的电脑上已经安装好了nodejs。

按照步骤执行以下命令:
$npm install gitbook-cli -g 下载gitbook客户端包
$gitbook –version 查看gitbook的版本,测试是否可以使用命令
$cd /users/Desktop 切换到一个目录,这里笔者切换到了桌面
$mkdir gitbook 创建gitbook目录,这个目录就是用来初始化的
其实上面的两步(切换目录和创建目录)读者可以手动完成。
$gitbook init 初始化gitbook目录
$gitbook build 构建,一般有内容更新时要构建
$gitbook serve 开启服务,默认在4000端口监听
访问http://localhost:4000 开启你的gitbook之路吧!

问题

你的系统 4000 端口可能已经被占用了,gitbook可以指定端口启动:
gitbook serve –port 2000

另一个问题是笔者在windows上搭建时遇到的:
笔者之前在windows上搭建过,出现了一些问题,build的时候总是报错。

在github官方issues中,官方表示这个是已知的gitbook的bug,高版本的gitbook会出现这个bug。
如果你遇到相同的问题,请参考gitbug上的解决方法
解决方法是点赞和喝彩最多的。

显示 Gitment 评论