创建版本化文档存档

时间:2016-07-31 16:10:27

标签: jekyll

我正在为一个开源项目重建API文档站点,我们希望保留以前版本的存档。我想知道如何配置Jekyll来生成正确的层次结构?

我们当前的/docs文件夹中有以下目录布局(我们希望以某种方式在Jekyll中重复使用):

current/
v1/
v2/
v3/

每当我们发布新版本时,current文件夹都会被复制到新文件夹(例如v4)。每个文件夹的内容都是这样的:

introduction.md
testing.md
api-foo.md
api-bar.md

我希望这些可以在网址domain.com/v3/testing/domain.com/current/testing/等下使用。我看到我可以使用集合来执行此操作,每个版本都有一个集合。为此,我看到自己将_config.yml自动更新为build script (I made an example doing this here)的一部分,但我不确定如何从这里开始,或者如果使用集合这是错误的方法......

1 个答案:

答案 0 :(得分:0)

对于真正质量的更新来说,这太简短了,但我想我会提到我们最终在Sinon项目中解决了这个问题。查看GitHub sinonjs / sinon的回购,查看docs文件夹以及从package.json调用的脚本。

通过编辑和添加内容和链接,随意改进此答案。