ch0ccyra1n/website-old
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README.md

Browse source
This commit is contained in:
ch0ccyra1n 2022-08-08 17:14:32 -07:00
parent 6212ff7ba3
commit 915df8540e
1 changed files with 6 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -1,6 +1,7 @@
Example [Hugo](https://gohugo.io) website using [GitLab Pages](https://about.gitlab.com/stages-devops-lifecycle/pages/).
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/).
## GitLab CI/CD
@ -14,17 +15,16 @@ 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. Install the theme as a Hugo module:
1. Update submodules:
```shell
hugo mod init gitlab.com/pages/hugo
hugo mod get -u github.com/theNewDynamic/gohugo-theme-ananke
git submodule update --init --recursive
```
1. Preview your project:
```shell
hugo server
hugo server --disableFastRender
```
1. Add content.
@ -36,50 +36,6 @@ To work locally with this project, you'll have to follow the steps below:
Read more at Hugo's [documentation](https://gohugo.io/getting-started/).
## Use a custom theme
Hugo supports a variety of themes.
Visit <https://themes.gohugo.io/> and pick the theme you want to use. In the
Pages example, we use <https://themes.gohugo.io/themes/gohugo-theme-ananke/>.
### Use a custom theme using a Hugo module
The example [`.gitlab-ci.yml`](.gitlab-ci.yml) uses Hugo modules to import the theme.
To use your own theme:
1. Edit `.gitlab-ci.yml`, and replace the URL in the `hugo mod get` line with the URL of your theme:
```yaml
- hugo mod get -u github.com/theNewDynamic/gohugo-theme-ananke
```
1. Edit `config.toml` and add the theme:
```plaintext
theme = ["github.com/theNewDynamic/gohugo-theme-ananke"]
```
## `hugo` vs `hugo_extended`
The [Container Registry](https://gitlab.com/pages/hugo/container_registry)
contains two kinds of Hugo Docker images, `hugo` and
`hugo_extended`. Their main difference is that `hugo_extended` comes with
Sass/SCSS support. If you don't know if your theme supports it, it's safe to
use `hugo_extended` since it's a superset of `hugo`.
The Container Registry contains three repositories:
- `registry.gitlab.com/pages/hugo`
- `registry.gitlab.com/pages/hugo/hugo`
- `registry.gitlab.com/pages/hugo/hugo_extended`
`pages/hugo:<version>` and `pages/hugo/hugo:<version>` are effectively the same.
`hugo_extended` was created afterwards, so we had to create the `pages/hugo/` namespace.
See [how the images are built and deployed](https://gitlab.com/pages/hugo/-/blob/707b8e367cdea5dbf471ff5bbec9f684ae51de79/.gitlab-ci.yml#L36-47).
## GitLab User or Group Pages
To use this project as your user/group website, you will need to perform
@ -88,7 +44,7 @@ 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`, from `"https://pages.gitlab.io/hugo/"` to `baseurl = "https://namespace.gitlab.io"`.
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).