背景
在研发一个系统,主要给公司内部同事用,按理说,简单点的话,搞个使用文档就行了,但产品经理希望是做成一个文档中心,比如,你学习个新技术的时候,比如vue,一般有个在线的帮助文档,他的想法就是这种。
我们就开始了调研,刚开始看了下wordpress(好多云服务器支持用这个来搭建网站),后面发现好复杂,我们只需要一个清爽的帮助文档而已;后面发现文档中心这种,主要分两类,一类是动态的,有数据库,有后台管理界面,可以在后台管理中去发布文档;一种是静态的,基本就是提供写好的markdown,然后部署到服务器上,用特定技术预先渲染成html,再利用nginx之类的指向这些html,一个静态文档中心就有了。
前一阵调研了一个叫gitbook的,属于静态方案,这里简单记录下搭建过程。
gitbook 简介
gitbook的官网是https://www.gitbook.com/,它官网主要是商业版本,就是个在线网站,你可以在里面写文档,体验还可以;
开源版本维护在github,https://github.com/GitbookIO/gitbook,文档也是在github维护:
https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md
目前,开源版本的发布包,最近一个版本是2018年10月,因为团队都去搞商业版本去了,这边就没维护了。
但是,gitbook做出来效果还可以,它也支持很多插件,由于gitbook是node开发的,所以插件就是各种npm包:
插件可以在npm官网查找,gitbook的插件都是有规范的,是gitbook-plugin-开头:
https://www.npmjs.com/search?ranking=popularity&q=gitbook-plugin-
gitbook做出来的网站的效果
示例1
https://handbook.enspiral.com/guides/blogging
该网站的搜索效果是做不出来的,这个是对接了专门的搜索网站
对应的github:https://github.com/enspiral/handbook
示例2
https://tutorial.djangogirls.org/
github:https://github.com/DjangoGirls/tutorial
开源版本可以做到的搜索的效果:
示例3
这边是一个中文站:
https://uprogrammer.cn/html5-cn/overview.html
大体效果就上面那些,如果觉得还可以,就可以看看怎么搭建了。
gitbook的fork版本
gitbook的开源版本没怎么维护了,但是后面社区又有人接着维护,那就是honkit
https://github.com/honkit/honkit
标签:info,md,plugin,gitbook,文档,https,root,搭建
From: https://www.cnblogs.com/grey-wolf/p/17779281.html