我可以在 GitLab 上渲染 HTML 吗？

Question

GitLab 不会为我呈现 HTML，而只是显示源代码：

背景：我使用 sphinx 生成 HTML 并尝试在 GitLab 显示文档。

我查看了其他项目的存储库，例如pandas 、 sphinx 。 它们在存储库中只有.rts文件，没有 HTML 文件。 我猜他们为他们的网站生成 HTML 但不上传到 Git。

我没有网站，想在 GitLab 上显示文档。 有没有办法做到这一点？ 还是我必须生成其他格式（HTML 除外，例如 PDF）？

Answer 1

首先，Git 和 GitLab 和 GitHub 等产品是不同的东西。 Git 从不渲染任何东西； 这是一个版本控制系统。 它没有网络界面。

其次，GitLab 的核心产品不应该渲染任何东西。 它不是 Web 主机，而是用于托管、共享和管理 Git 存储库的工具。 但是，您可能想尝试GitLab Pages ：

GitLab Pages 是一项功能，允许您直接从 GitLab 中的存储库发布静态网站。

您可以将它用于个人或商业网站，例如投资组合、文档、宣言和商业演示。 您还可以将任何许可归于您的内容。

所有 GitLab.com 用户以及自我管理的实例（GitLab Core、Starter、Premium 和 Ultimate）均可免费使用 Pages。

GitLab Pages 将从您存储库的public/目录发布内容，因此您应该将文件移动到那里。 您还需要一个.gitlab-ci.yml文件在您的存储库的根目录中，其中包含类似的内容

image: alpine:latest

pages:
  stage: deploy
  script:
  - echo 'Nothing to do...'
  artifacts:
    paths:
    - public
  only:
  - master

（取自示例存储库）。 添加该文件，然后提交并推送。 部署完成后，您的站点应该可以在https://youruser.gitlab.io/yourproject 。

请注意，GitHub 有一个类似的产品（工作方式不同）。

最后，

我查看了其他项目的存储库，例如pandas 、 sphinx 。 他们在存储库中只有.rts文件，而不是 HTML 文件。 我猜他们会为他们的网站生成 HTML，但不会上传到 Git。

很可能reStructured Text文件是唯一存在的源，并且 HTML 是从它们自动生成的。 Sphinx 默认采用这种格式。 如果您对使用 Markdown 或 reStructured Text 等其他格式感兴趣，您可能需要探索 GitLab Pages 对静态站点生成器的支持。

Answer 2

我在这篇文章中找到了一个超级简单的解决方案：

前：
https://gitlab.com/[user]/[repository]/raw/[branch]/[filename.ext]

后：
开发（节流）
https://gl.githack.com/[user]/[repository]/raw/[branch]/[filename.ext]

生产（CDN）
https://glcdn.githack.com/[user]/[repository]/raw/[branch]/[filename.ext]

Answer 3

另一种解决方案：

在 repo 的根目录下，添加一个名为.gitlab-ci.yml的文件，其中包含以下几行：

pages:
 script:
 - mkdir .public
 - cp -r * .public
 - mv .public public
 artifacts:
    paths:
    - public

您的文件应该可以在

 https://your-username.gitlab.io/project-name/filename.html

有关详细信息，请参阅此帖子： Gitlab：托管和渲染 HTML 文件