diff --git a/README.md b/README.md index fbab18b..9d85ee6 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,6 @@ documentation https://docs.gitlab.com/ce/user/project/pages/. **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) @@ -21,10 +20,13 @@ documentation https://docs.gitlab.com/ce/user/project/pages/. -## GitLab CI +## Using docker-compose -This project's static Pages are built by [GitLab CI][ci], following the steps -defined in [`.gitlab-ci.yml`](.gitlab-ci.yml). +To build and serve locally without installing anything, provided that you have docker running: + + docker-compose up + +Then browse http://localhost:1313/ ## Building locally @@ -45,25 +47,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: @@ -72,7 +55,6 @@ unless you want to contribute back to the upstream project. 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/ [documentation]: https://gohugo.io/overview/introduction/