[发明专利]一种自动化的多产品文档统一发布展示方法

权利要求书

1.一种自动化的多产品文档统一发布展示方法，其特征在于,其实现包括Webhook监听服务与渲染管线服务两部分；

Webhook监听服务以Web服务形式提供一个持续运行的API接口，来接收代码仓库推送的markdown文档源码更新事件，并根据接收的更新事件提取请求数据包内的参数，随后将数据包内记录的仓库信息和版本信息发送至渲染管线服务；

渲染管线服务中预定义有流水管线，渲染管线服务用于接收Webhook监听服务派送的文档更新任务，并将任务数据交给内部空闲的工作队列，工作队列接收到任务数据后，启动预定义的流水管线依次渲染每个markdown文档，并生成对应的静态网页，最终自动发布更新到站点，用户访问站点链接即可查看最新生成的文档页面。

2.根据权利要求1所述的一种自动化的多产品文档统一发布展示方法，其特征在于，所述方法基于Git版本控制工具实现markdown文档内容的存储、编辑、协作和版本控制，并使用Gitlab进行Git仓库的集中存储托管，使用Gitlab提供的Webhook功能实现根据markdown文档源码变更自动更新站点内容。

3.根据权利要求1所述的一种自动化的多产品文档统一发布展示方法，其特征在于，当用户修改了markdown文档或者发布了新版本的TAG并将变更推送到代码仓库中时,代码仓库根据Webhook监听服务提供的API接口接收代码仓库推送的markdown文档源码更新事件。

4.根据权利要求1所述的一种自动化的多产品文档统一发布展示方法，其特征在于，工作队列的任务数据执行完成后，工作队列重新转入空闲状态，等待渲染管线服务派发下一次文档更新任务。

5.根据权利要求1所述的一种自动化的多产品文档统一发布展示方法，其特征在于，采用Hugo文档渲染工具进行渲染管线服务。

6.根据权利要求5所述的一种自动化的多产品文档统一发布展示方法，其特征在于，Hugo文档渲染工具使用Golang语言编写。

7.根据权利要求5所述的一种自动化的多产品文档统一发布展示方法，其特征在于，采用Hugo文档渲染工具进行渲染管线服务，具体工作流程如下：

(1)拉取最新文档：根据派发的任务信息，通过git命令拉取代码仓库上最新版本的markdown文档；

(2)解析版本信息：从更新后的代码仓库中解析历史版本以及tag信息，写入临时配置文件，供后续流程使用；

(3)解析文档目录树：解析原目录树的配置文件，并根据其中配置的目录层级关系，解析为树形数据结构，存入变量供后续步骤使用；

(4)配置内容目录结构：根据前一步目录树结构，将目录树中每一级对应的markdown源码文件存入临时工作目录，同时，根据前面提取的版本tag信息，配置到对应版本的目录，实现历史版本保留以及多版本切换浏览；

(5)内容预处理:依次处理markdown文档内容，根据预定义的流水管线以及对应的目录和标题信息，插入页首页尾元数据，供Hugo渲染时配置页面使用；

(6)配置Hugo文档渲染工具：一个markdown文档仓库为一个独立的文档站点，所有markdown文档仓库的文档站点组成一个聚合站点，使用Hugo文档渲染工具对每个markdown文档仓库进行独立配置；

(7)渲染文档:配置完成后，调用Hugo命令，将临时工作目录中的markdown文档仓库渲染并输出为一系列静态html页面以及对应的图片、样式表；

(8)部署文档：将输入的静态资源拷贝到服务器的部署目录，服务器可通过配置web服务提供静态站点的浏览服务，也可静态页面服务，无需部署环节；

(9)更新聚合首页：设计卡片式静态页面，以为文档浏览者提供一个统一的聚合入口，卡片式静态页面将所有产品文档以卡片形式展示在首页，点击卡片即可进入对应的文档站点。

8.根据权利要求7所述的一种自动化的多产品文档统一发布展示方法，其特征在于，所有卡片根据仓库配置信息以及动态读取的描述信息自动生成，并自动更新。