Github Pages - 维护多个版本

Question

我需要托管我的项目的多个版本（比如 1.0、2.0 和 3.0）的文档，并且都是活动（文档）分支，我们将继续对所有这些进行改进。是否可以为此目的使用 GitHub 页面？

感谢您对此的任何帮助。

Answer 1

使用Github Actions以及您选择的静态站点生成器（SSG）（例如VuePress、Gatsby、Jekyll等）是可行的。

最简单的形式是，创建一个 GH 操作来生成分支/发布的静态站点文件夹，然后将该文件夹推送到 GH 页面指向的分支中的相应文件夹，例如gh-pages。应将分支/版本之一推送到根目录。GitHub Pages 部署操作可能会有所帮助。最后将版本下拉列表添加到指向匹配文件夹的静态网站。可以使用 GitHub API 静态维护或动态填充项目列表。所选项目取决于当前 URL 路径。

例子：

为软件产品NotifyBC提供多版本文档，文档和代码在同一个仓库中，

• input - VuePress 创建的产品的docs文件夹
• 输出 - gh-pages分支
• GitHub action，主分支推送到gh-pages分支的根目录，发布版本推送到版本文件夹。当某个版本不再受支持时，只需手动将其从版本文件夹中删除即可。
• Vue组件中实现的动态填充下拉列表
• 渲染站点

Answer 2

您可以查看gh-pages-multi。

这是我编写的一个小型 Nodejs 工具，用于将不同版本的文档推送到 gh-pages 分支中的子目录。它还生成一个 index.html 文件，列出这些子目录。

如果您想自动构建和推送文档，那么集成到 CI 工作流程中相当容易。

另请注意“--no-history”选项，如果您的文档包含一些构建文件或二进制资产，该选项将防止 git 存储库膨胀。