使用git、gitbook、openresty实现自动化部署文档中心

本文介绍了如何利用git管理文档,gitbook生成网站,以及通过openresty实现自动化部署,解决项目文档管理、分享不便的问题。详细讲述了gitbook的安装、初始化、构建、提交流程,以及openresty的安装和配置,包括自动部署接口的实现。文章最后讨论了git hook在自动部署中的作用,并指出了方案的不足之处。
摘要由CSDN通过智能技术生成

由于在项目管理中,发现文档的统一管理和传阅非常不方便。
例如使用word,excel等工具,文档零散且分享没有实时性;
使用svn或者git管理,文档可以统一,且可以追溯历史,但是对于分享而言,使用成本过高。

在无意中发现一个叫做gitbook的东西,可以将书籍用git的方式管理,阅读的时候时候则可以通过网站阅读,正好一次性解决了之前的问题。
在调研过程中,发现了许多问题,比如gitbook官方使用是收费的,并且在网络不稳定,而且资料公开在外网。
该文章就是为了解决上述问题而做出的一种实现。

思路

  1. 通过git管理文档
  2. 通过gitbook生成网站
  3. 通过openresty访问网站和编写相应的gitbook自动部署
  4. 通过gitbook的hook钩子触发gitbook自动部署

git

就是git的安装和使用,我这里使用的是gitea,相对gitlab来说,更轻量方便使用。
具体过程略,有需要的请自行百度/google。

gitbook

1.安装

这里使用npm安装,如果不了解了,请先行学习npm安装。
执行以下命令即可安装。

npm install gitbook-cli -g

如果已经安装过了,再次安装,有时候就会安装失败,并且之前的也不能用了。这时候需要先卸载gitbook-cli,命令如下

npm uninstall gitbook-cli -g

2.初始化

在创建好的目录中初始化gitbook

gitbook init

如果您希望将书籍创建到一个新目录中,可以通过运行 gitbook init ./directory 这样做

3.构建

使用下面的命令,会在项目的目录下生成一个 _book 目录,里面的内容为静态站点的资源文件

gitbook build

在这一步构建出来的_book就是我们可以直接通过openresty映射出来的文档网页了。

4.编写

由于网上有很多介绍gitbook如何编写和使用的资料,且这个不是该文章要说明的重点,这里就不重复说明了。

更多关于gitbook的详细说明请打开大佬的gitbook相关资料 [使用 Gitbook 打造你的电子书]。

5.提交git

编写好gitbook以后,就可以提交到git了,然后就是通过git的hook去触发自动部署了。

  • 2
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值