2.9 KiB
Example Hugo website using GitLab Pages.
Learn more about GitLab Pages at https://pages.gitlab.io and the official documentation https://docs.gitlab.com/ce/user/project/pages/.
Table of Contents generated with DocToc
GitLab CI
This project's static Pages are built by GitLab CI, following the steps
defined in .gitlab-ci.yml.
Building locally
To work locally with this project, you'll have to follow the steps below:
- Fork, clone or download this project
- Install Hugo
- Preview your project:
hugo server - Add content
- Generate the website:
hugo(optional)
Read more at Hugo's documentation.
Preview your site
If you clone or download this project to your local computer and run hugo server,
your site can be accessed under localhost:1313/hugo/.
The theme used is adapted from http://themes.gohugo.io/beautifulhugo/.
GitLab User or Group Pages
To use this project as your user/group website, you will need one additional
step: just rename your project to namespace.gitlab.io, where namespace is
your username or groupname. This can be done by navigating to your
project's Settings.
You'll need to configure your site too: change this line
in your config.toml, from "https://pages.gitlab.io/hugo/" to baseurl = "https://namespace.gitlab.io".
Proceed equally if you are using a custom domain: baseurl = "http(s)://example.com".
Read more about user/group Pages and project Pages.
Did you fork this project?
If you forked this project for your own use, please go to your project's Settings and remove the forking relationship, which won't be necessary unless you want to contribute back to the upstream project.
Troubleshooting
-
CSS is missing! That means two things:
Either that you have wrongly set up the CSS URL in your templates, or your static generator has a configuration option that needs to be explicitly set in order to serve static assets under a relative URL.