由于项目需要帮助文档,于是我这边选择使用了gitbook,这边做一个使用的记录,以及遇到的问题。
安装方式
npm install -g gitbook-cli
初始化
建一个文件夹,然后git bash 输入
gitbook init
这一步运气好的小伙伴可能一步就成功了,不会一直卡在
Installing GitBook 3.2.3
哈哈哈,我偏偏就是运气不好的那一个人。
然后在网上各种百度搜索解决方法。重点来了。
总结
// 1、node版本,gitbook支持的最好的版本是 node 10X ,我的版本是 8X ,遂改为10X
// 2、镜像源太慢,更换镜像源:
npm config set registry=http://registry.npm.taobao.org
上述更换完之后,在重新安装gitbook
如果上面俩办法还是不行,那你就是运气特别不好的小伙伴了,哈哈哈,自己百度去吧~~~ hhhh
使用
你成功gitbook init 之后,你的文件夹里面会出现,以下文件
就这俩,SUMMARY.md是一个目录页面,在这里输入目录,可以自动创建相关文件。
在这里按照以下命名方式就可以了
目录名字
以下是我的部分目录小伙伴们可以直接复制,之后在gitbash里面gitbook init初始化以下,就会发现已经自动创建了目录里面的文件了。
账户管理
* [注册](accountInfo/register.md)
* [登录](accountInfo/login.md)
* [用户充值](accountInfo/charge.md)
* [升级到专业版](accountInfo/professional.md)
* [索要发票](accountInfo/invoice.md)
不过需要注意就是,这个创建文件只适用于初始化噢,如果你已经编写了内容的话,这个方法,会让你丢失你之前保存的内容噢,毕竟是初始化嘛。
启动服务
gitbash里面输入gitbook serve启动服务
gitbook serve
控制台会输入以下内容
这就是成功的启动服务啦,在浏览器里面输入http://localhost:4000就可以以网页的方式查看我们写的电子书啦。
还有就是这个服务一旦你修改内容保存之后就会断掉,需要重新启动。
打包项目
gitbash 输入 gitbook build
gitbook build
文件下面会生成一个 _book文件,就是我们的打包文件了。
访问里面的index,html 就可以看到我们的打包的项目了。
遇到的问题:打包之后的页面,左边的目录点击没有反应。
解决方式:
打包文件里面找到这个theme.js文件,路径为 _book/gitbook/theme.js。打开文件全局搜索 if(m)for(n.handler&&(i=n,n=i.handler,o=i.selector)
将if(m)
改为if(false)
。就可以正常访问了。