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

Question

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

现在，在将存储库推送到 Github 之前，我正在手动生成文档(在我的本地)。/docs 文件夹由 github 页面提供。将文档文件包含到提交中会使提交大得令人困惑。如果可以在 github 中执行 compodoc 脚本并在那里生成 docs 文件夹，那就太好了。

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

Answer 1

我是Compodoc的核心维护者。

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

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

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

- npm 运行文档
- bash ./deploy.sh

在这个部署脚本中，我只是移动到文档文件夹，并在 gh-pages 分支上提交所有内容。

光盘文档
混帐添加。 &&\
git commit -m "部署到 GitHub 页面"&&\
git push --force "https://${GH_TOKEN}@${GH_REF}"master:gh-pages >/dev/null 2>&1


问候