admin 管理员组文章数量: 1086760
windows下安装并使用gitbook
目录
-
gitbook的用途
-
gitbook的依赖环境
-
nodejs的安装
-
gitbook的安装
-
gitbook的使用
-
gitbook开启多个服务
-
gitbook serve报错
gitbook的用途
gitbook官网上给出的定位是这样的:
GitBook helps you publish beautiful docs for your users and centralize your teams’ knowledge for advanced collaboration.(翻译过来是这样的:GitBook可以帮助您为用户发布漂亮的文档,并集中团队的知识以实现高级协作)
对于个人来说,使用gitbook无非就是将markdown文档生成html文件,而且提供了一个本地服务器,以便能够在浏览器上进行本地访问(反正我目前就使用了这个功能)。
gitbook的依赖环境
gitbook的安装依赖nodejs的npm包管理功能,而windows没有这样的环境。所以需要在windows平台上安装nodejs。
nodejs的安装
这里建议在nodejs的中文网上下载安装,速度会更快。这里给出了下载nodejs各个版本的网址:
https://npm.taobao/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
查看自己安装是否成功。
gitbook安装
直接使用以下命令可以安装gitbook:
npm install gitbook-cli -g
安装该命令安装后gitbook包会默认放在nodejs安装路径下的node_global文件夹下,所以要想全局使用gitbook命令,还需要将该文件夹设置为环境变量。
设置完环境变量后,可以在控制台使用gitbook -V
查看是否安装成功(这里V是大写)。
gitbook使用
新建一个文件夹,例如first-gitbook,在控制台进入到该文件夹下,使用`gitbook init`进行初始化。在文件夹下会生成两个markdown文档:README和SUMMARY,初始化完成。然后使用gitbook serve
命令,该命令会将文件夹下生成一个_book文件夹,该文件夹下是生成的网站结构,包括gitbook自带的网页排版。同时会启动本地服务器,我们可以使用localhost:4000访问到。
-
README文档中的内容就是网站的index主页的内容。
-
SUMMARY文档描述了网站的结构。
这里我给出我写的具体例子。
README文档内容:
SUMMARY文档内容:
网站效果图:
gitbook开启多个服务
如果你想同时编辑两个或多个gitbook,使用gitbook serve
命令会报错。这是因为使用gitbook会默认使用电脑的35729端口给4000端口提供服务。使用gitbook serve
命令时发现这两个端口被占用而退出。
但是gitbook提供了命令可以修改默认端口。使用如下命令就能达到这样的效果:
gitbook serve --lrport 35728 --port 4001
gitbook serve报错
在使用gitbook serve命令时可能会出现下图的错误:
我们只需要找到报错所说的polyfills.js文件,找到287行,发现是一个名为statFix的函数声明。使用查找命令找到该函数的调用地方,注释掉即可。
选择10.21.0版本的gitbook不会出现以上报错。
版权声明:本文标题:windows下安装并使用gitbook(详细版) 内容由网友自发贡献,该文观点仅代表作者本人, 转载请联系作者并注明出处:http://roclinux.cn/b/1747670375a2569522.html, 本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,一经查实,本站将立刻删除。
发表评论