68 lines
2.3 KiB
Markdown
68 lines
2.3 KiB
Markdown
|
|
|
|
---
|
|
|
|
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)*
|
|
|
|
- [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)
|
|
|
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
|
|
## Using docker-compose
|
|
|
|
To build and serve locally without installing anything, provided that you have docker running:
|
|
|
|
docker-compose up
|
|
|
|
Then browse http://localhost:1313/
|
|
|
|
## 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][] Hugo
|
|
1. Preview your project: `hugo server`
|
|
1. Add content
|
|
1. 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/.
|
|
|
|
## 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.
|
|
|
|
1. SSL certificate expired
|
|
|
|
see https://about.gitlab.com/2016/04/11/tutorial-securing-your-gitlab-pages-with-tls-and-letsencrypt/
|
|
(until we automate it with https://github.com/rolodato/gitlab-letsencrypt or custom api script)
|
|
|
|
[hugo]: https://gohugo.io
|
|
[install]: https://gohugo.io/overview/installing/
|
|
[documentation]: https://gohugo.io/overview/introduction/
|
|
[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages
|
|
[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages
|
|
[post]: https://about.gitlab.com/2016/04/07/gitlab-pages-setup/#custom-domains
|