Web

windows下安装并使用gitbook

michaelliunsky · 8月19日 · 2022年 · · 本文共1378个字 · 预计阅读5分钟853次已读

最近看到一些网站使用了GITBOOK,自己也很喜欢它那简约的风格,于是就在本地抽空搭建了一个O(∩_∩)O~~

gitbook的依赖环境

gitbook的安装依赖nodejs的npm包管理功能,而windows没有这样的环境。所以需要在windows平台上安装nodejs。

nodejs的安装

这里建议在nodejs的中文网上下载安装,速度会更快。这里给出了下载nodejs各个版本的网址:

https://npm.taobao.org/mirrors/node/

推荐下载v12.x版本,因为本人亲测可以使用。不建议下载v16.x版本,因为本人亲测版本和gitbook不兼容。至于其他版本是否可行就需要大家亲自实验了。对于每一个版本在windows平台下都有以下几种:

node-v12.20.1-win-x64.7z       04-Jan-2021 12:41    0661888(10.17MB)
node-v12.20.1-win-x64.zip      04-Jan-2021 12:42    18672143(17.81MB)
node-v12.20.1-win-x86.7z       04-Jan-2021 12:20    9579436(9.14MB)
node-v12.20.1-win-x86.zip      04-Jan-2021 12:20    17127042(16.33MB)
node-v12.20.1-x64.msi          04-Jan-2021 12:43    19664896(18.75MB)
node-v12.20.1-x86.msi          04-Jan-2021 12:21    18026496(17.19MB)

下载首先排除x86文件,剩下的.7z和.zip是压缩文件,直接解压就行,无需安装,但是需要自己配置npm的环境变量。msi文件不需要解压,但是需要安装,安装时会默认配置好环境变量。大家根据需要自行选择。

安装成功后,可以在控制台使用node -v查看自己安装是否成功。

windows下安装并使用gitbook
node -v

gitbook安装

直接使用以下命令可以安装gitbook:

npm install gitbook-cli -g

安装该命令安装后gitbook包会默认放在nodejs安装路径下的node_global文件夹下,所以要想全局使用gitbook命令,还需要将该文件夹设置为环境变量

设置完环境变量后,可以在控制台使用gitbook -V查看是否安装成功(这里V是大写)。

windows下安装并使用gitbook

报错的解决办法:

在使用gitbook serve命令时可能会出现下图的错误:

windows下安装并使用gitbook
error

我们只需要找到报错所说的polyfills.js文件,注释掉几行代码即可。

windows下安装并使用gitbook
如图注释代码

gitbook使用

新建一个文件夹,例如first-gitbook,在控制台进入到该文件夹下,使用’gitbook init’进行初始化。在文件夹下会生成两个markdown文档:README和SUMMARY,初始化完成。

然后使用gitbook serve命令,该命令会将文件夹下生成一个_book文件夹,该文件夹下是生成的网站结构,包括gitbook自带的网页排版。同时会启动本地服务器,我们可以使用localhost:4000访问到。

  • README文档中的内容就是网站的index主页的内容。
  • SUMMARY文档描述了网站的结构

总结

中间遇到过很多报错的提示,就中途切断了安装的进程,实际上那些报错直接忽略就好,最后可以安装成功的。

0 条回应