GitHub项目的文档版本控制

时间:2017-07-20 12:14:28

标签: github

在处理代表重大改写的新版本时,GitHub建议如何组织文档?

在我的项目pg-promise中,我依靠jsDoc生成all the documentation,然后像往常一样将其发布到gh-pages

在处理重大改写和文档更改的新版本时,制作新的/未发布的文档的最佳方法是什么? -

1。我是否应该仅为了在那里发布更新的文档而创建一个单独的存储库?

2. 我应该完全使用外部托管/解决方案吗?

3. 是否有任何GitHub功能可以让我发布多个文档版本?

提前致谢!

1 个答案:

答案 0 :(得分:1)

使用Github Actions以及您选择的静态站点生成器(SSG),例如VuePressGatsbyJekyll等是可行的。

以最简单的形式,创建GH动作以生成分支/发行版的静态站点文件夹,然后将该文件夹推送到GH页面所指向的分支中相应的文件夹,例如 gh-pages 。分支/发行版之一应推入根目录。 GitHub Pages Deploy Action可能会有所帮助。在指向匹配文件夹的静态网站中添加版本下拉列表。

示例: