Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
SOAFEE
website
Commits
1ac64228
Commit
1ac64228
authored
Nov 26, 2021
by
Matt Spencer
Browse files
Remove boilerplate readme
parent
5963e51c
Pipeline
#117
passed with stages
in 8 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
1ac64228

---
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/.

---
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
*generated with [DocToc](https://github.com/thlorenz/doctoc)*
-
[
GitLab CI
](
#gitlab-ci
)
-
[
Building locally
](
#building-locally
)
-
[
GitLab User or Group Pages
](
#gitlab-user-or-group-pages
)
-
[
Did you fork this project?
](
#did-you-fork-this-project
)
-
[
Troubleshooting
](
#troubleshooting
)
This repositoy holds the sources for the soafee.io website.
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
A build of the website is trigged by a merge into the main branch of this repository.
## GitLab CI
This project's static Pages are built by
[
GitLab CI
][
ci
]
, following the steps
defined in
[
`.gitlab-ci.yml`
](
.gitlab-ci.yml
)
.
The website is built using [Hugo].
## Building locally
...
...
@@ -45,33 +26,6 @@ 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
][
post
]
:
`baseurl = "http(s)://example.com"`
.
Read more about
[
user/group Pages
][
userpages
]
and
[
project Pages
][
projpages
]
.
## 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
1.
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.
[
ci
]:
https://about.gitlab.com/gitlab-ci/
[
hugo
]:
https://gohugo.io
[
install
]:
https://gohugo.io/overview/installing/
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment