前言
需求是内部想部署一个帮助文档功能,参考页面。 第一印象跟chm搞混了, chm是文件形式的帮助文档,可以传输,即使达成了chm编辑和发布最终也是以html或其它web页面的形式展示和维护。
度娘搜索到一个同类项目列表连接地址。如博主介绍同类项目很多, 没有精力全部试一遍,其中gitgook有听过领导提过,就从这里下手。
环境部署
- win10
- node.js 10.24.1
- gitbook3.2.3
安装node.js 10.24.1
参考地址:https://www.jianshu.com/p/0388d8bb49a7
node.js下载页https://nodejs.org/en
注意
- nodejs版本目前必须是10.24.1。据说是gitbook这个项目不再维护,无法兼容最新版的node.js, 尝试了网上关于最新版的解决办法还是不行
- 各版本的nodejs对应不同的npm,卸载/重装时记得删除npm文件夹
点击Other Downloads
下载10.24.1, 滑倒接近页面底部,点击Previous Releases
安装完成后查看版本信息要与上面列表列出的一致
nodejs -v
npm -v
安装gitbook参考连接
npm install -g gitbook-cli
Gitbook的使用参考连接
在你想要的位置新建一个文件夹,然后打开命令行,cd到这个文件夹下。
接着执行以下命令
gitbook init
将summary编辑成下面这个样子
# Summary
* [Introduction](README.md)
* [前言](readme.md)
* [第一章](part1/README.md)
* [第一节](part1/1.md)
* [第二节](part1/2.md)
* [第三节](part1/3.md)
* [第四节](part1/4.md)
* [第二章](part2/README.md)
* [第三章](part3/README.md)
* [第四章](part4/README.md)
写完目录后再次执行gitbook init Gitbook会查找SUMMARY.md中描述的目录和文件,如果没有则会创建。
配置gitbook。 添加 book.json文件
{
"title": "骑士指南",
"description": "要想成为强者,决不能绕过挡道的荆棘,也不能回避风雨的冲刷",
"author": "公爵",
"output.name": "site",
"language": "zh-hans",
"plugins":
[
"toggle-chapters",
"hide-element",
"tbfed-pagefooter",
"-lunr","-search","search-pro",
"insert-logo"
],
"pluginsConfig": {
"hide-element": {
"elements": [".gitbook-link"]
},
"tbfed-pagefooter": {
"copyright": "Copyright © 公爵 2022",
"modify_label": "该文章修订时间:",
"modify_format": "YYYY-MM-DD"
},
"insert-logo": {
"url": "https://cos.gjcloak.xyz/2022/04/28/6269f3340b765.png",
"style": "background: none"
}
}
}
执行命令安装插件
gitbook install
执行命令开启预览,其中serve可以指定端口
gitbook serve
提示本地预览地址http://localhost:4000/
待解决问题:
- 文档编辑维护
- 项目部署收费问题