在不使用 GitLab Pages 的情况下在 GitLab 上部署 Compodoc 文档
Deploy Compodoc documentation on GitLab without using GitLab Pages
尊敬的开发人员,
我想将我们的 Compodoc
文档部署到 GitLab
,以便我们团队中的每个开发人员都可以使用它(例如 API 页面)。
根据我工作的公司,我不能为此使用 GitLab
页面。
有什么想法吗?
感谢任何帮助
我工作的公司出于某种原因不允许使用 GitLab 页面。所以我不得不想出另一个解决方案。
Please keep in mind that I was looking for a way to make the
documentation accessible to every developer.
为此,我基本上必须执行两个步骤:
修改package.json
"docgen": "./node_modules/.bin/compodoc -p src/tsconfig.app.json",
"doc:buildandserve": "compodoc -p src/tsconfig.app.json -s",
"bundle-report": "webpack-bundle-analyzer dist/stats.json"
这将在任何地方构建和提供文档
已部署。
修改构建管道
我不得不在我的管道中插入一个额外的步骤来执行上面的代码,以便开发人员可以访问 http:\www.your-applications-url.com\documentation
之类的文档
希望对您有所帮助。
尊敬的开发人员,
我想将我们的 Compodoc
文档部署到 GitLab
,以便我们团队中的每个开发人员都可以使用它(例如 API 页面)。
根据我工作的公司,我不能为此使用 GitLab
页面。
有什么想法吗?
感谢任何帮助
我工作的公司出于某种原因不允许使用 GitLab 页面。所以我不得不想出另一个解决方案。
Please keep in mind that I was looking for a way to make the documentation accessible to every developer.
为此,我基本上必须执行两个步骤:
修改
package.json
"docgen": "./node_modules/.bin/compodoc -p src/tsconfig.app.json",
"doc:buildandserve": "compodoc -p src/tsconfig.app.json -s",
"bundle-report": "webpack-bundle-analyzer dist/stats.json"
这将在任何地方构建和提供文档 已部署。
修改构建管道
我不得不在我的管道中插入一个额外的步骤来执行上面的代码,以便开发人员可以访问
http:\www.your-applications-url.com\documentation
之类的文档
希望对您有所帮助。