75 lines
2.9 KiB
Markdown
75 lines
2.9 KiB
Markdown
ch0ccyra1n's personal website, built using GitLab Pages and GitLab CI/CD.
|
|
|
|
Learn more about GitLab Pages at the [official documentation](https://docs.gitlab.com/ce/user/project/pages/).
|
|
Learn more about GitLab CI/CD at the [official documentation](https://docs.gitlab.com/ee/ci/).
|
|
|
|
## Building locally
|
|
|
|
To work locally with this project, you'll have to follow the steps below:
|
|
|
|
1. Fork, clone or download this project.
|
|
1. Install `git` and `go`.
|
|
1. [Install](https://gohugo.io/getting-started/installing/) Hugo.
|
|
1. Update submodules:
|
|
|
|
```shell
|
|
git submodule update --init --recursive
|
|
```
|
|
|
|
1. Preview your project:
|
|
|
|
```shell
|
|
hugo server --disableFastRender
|
|
```
|
|
|
|
1. Add content.
|
|
1. Optional. Generate the website:
|
|
|
|
```shell
|
|
hugo
|
|
```
|
|
|
|
Read more at Hugo's [documentation](https://gohugo.io/getting-started/).
|
|
|
|
## GitLab User or Group Pages
|
|
|
|
To use this project as your user/group website, you will need to perform
|
|
some additional steps:
|
|
|
|
1. 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 > General (Advanced)**.
|
|
1. Change the `baseurl` setting in your `config.toml` to `baseurl = "https://namespace.gitlab.io"`.
|
|
Proceed equally if you are using a custom domain: `baseurl = "https://example.com"`.
|
|
|
|
Read more about [GitLab Pages for projects and user/group websites](https://docs.gitlab.com/ce/user/project/pages/getting_started_part_one.html).
|
|
|
|
## 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.
|
|
|
|
### Hugo fails to build the website
|
|
|
|
If the version of `hugo` or `hugo_extended` is 0.92.2 or later, you may have problems building the website.
|
|
|
|
Generics were introduced in [Go 1.18](https://go.dev/blog/go1.18), and they broke some features in the newer versions of Hugo. For now, if you use `hugo` or `hugo_extended` versions 0.92.2 or later, you might encounter problems building the website. To resolve the problem:
|
|
|
|
1. Edit your `.gitlab-ci.yaml` file.
|
|
1. Identify the line that declares the Hugo version.
|
|
1. Change the value to `:0.92.2`.
|
|
1. Save your changes
|
|
|
|
For more information about this issue:
|
|
|
|
- This issue is tracked in [Gitlab Hugo template fails CI/CD build with "latest" docker version](https://gitlab.com/pages/hugo/-/issues/69).
|
|
- For discussions about fixing the problem in Hugo, and proposals to potentially resolve these issues, read [proposal: spec: allow type parameters in methods](https://github.com/golang/go/issues/49085).
|