角度2> Compodoc> Github Pages上的服务/文档

时间:2017-03-22 08:50:01

标签: angular github-pages

我正在使用compodoc为我的Angular项目生成文档。

现在,在将回购推送到Github之前,我手动生成文档(在我的本地)。 / docs文件夹由github页面提供服务。将docs文件包含在提交中会使提交容易混淆。如果compodoc脚本可以在github中执行并且在那里生成docs文件夹,那将是非常好的。

我知道Github不是构建代码的地方,但据我所知,你可以用Jeykll生成这种工作流程。有没有人解决过这样的问题?

2 个答案:

答案 0 :(得分:5)

我是Compodoc的核心维护者。

请查看演示存储库:https://github.com/compodoc/compodoc-demo-todomvc-angular

这是一个很好的例子,说明如何提供生成的文档。有一个特拉维斯的任务。查看travis.yml文件。

它首先运行运行compodoc的npm doc任务。在启动部署脚本之后。

- npm run doc - bash ./deploy.sh

在这个部署脚本中,我只需要进入文档文件夹,然后在gh-pages分支上提交所有内容。

cd documentation git add . && \ git commit -m "Deploy to GitHub Pages" && \ git push --force "https://${GH_TOKEN}@${GH_REF}" master:gh-pages > /dev/null 2>&1

此致

答案 1 :(得分:0)

我通过执行以下操作在詹金斯(Jenkins)工作中完成了这项工作:

git add docs && git commit -m "my commit message"  
git push origin `git subtree split --prefix docs master`:gh-pages --force

我在评论here

中找到了答案