我可以在GitLab上呈现HTML吗?

问题描述 投票:1回答:1

GitLab不为我呈现HTML,只是显示源代码:

enter image description here

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

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

我没有网站,想在GitLab上展示文档。有没有办法做到这一点?或者我是否必须生成其他格式(HTML除外,例如PDF)?

html git gitlab python-sphinx
1个回答
2
投票

首先,Git和GitLab和GitHub等产品是不同的东西。 Git永远不会呈现任何东西;它是一个版本控制系统。它没有Web界面。

其次,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

(取自sample repository)。添加该文件,然后提交并推送。部署完成后,您的站点应该是available at https://youruser.gitlab.io/yourproject

请注意,GitHub有a similar product(工作方式不同)。

最后,

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

reStructured Text文件很可能是唯一存在的源,并且HTML是自动生成的。 Sphinx this format by default。如果您对使用Markdown或reStructured Text等其他格式感兴趣,您可能需要探索GitLab Pages的support for static site generators

© www.soinside.com 2019 - 2024. All rights reserved.