Merge branch 'note-preview-and-user-site' into 'master'

update README

Fixes #2 

- Add note: preview site at `localhost:1313/hugo/` - see https://gitlab.com/pages/hugo/issues/2#note_4728574 - no need to add `--baseurl` flag to the `server` command (tested locally)

- Move the step "Generate the website: `hugo`" to the end - it's a non-required step

- Add note regarding user/group site and custom domain

cc/ @axil 



See merge request !2
This commit is contained in:
Achilleas Pipinellis 2016-04-20 12:56:32 +00:00
commit ee59cdc8bc

View File

@ -45,12 +45,17 @@ To work locally with this project, you'll have to follow the steps below:
1. Fork, clone or download this project 1. Fork, clone or download this project
1. [Install][] Hugo 1. [Install][] Hugo
1. Generate the website: `hugo`
1. Preview your project: `hugo server` 1. Preview your project: `hugo server`
1. Add content 1. Add content
1. Generate the website: `hugo` (optional)
Read more at Hugo's [documentation][]. 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/`.
## GitLab User or Group Pages ## GitLab User or Group Pages
To use this project as your user/group website, you will need one additional To use this project as your user/group website, you will need one additional
@ -58,6 +63,10 @@ step: just rename your project to `namespace.gitlab.io`, where `namespace` is
your `username` or `groupname`. This can be done by navigating to your your `username` or `groupname`. This can be done by navigating to your
project's **Settings**. 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 equaly if you are using a [custom domain][post]: `baseurl = "http(s)://example.com"`.
Read more about [user/group Pages][userpages] and [project Pages][projpages]. Read more about [user/group Pages][userpages] and [project Pages][projpages].
## Did you fork this project? ## Did you fork this project?
@ -80,3 +89,4 @@ unless you want to contribute back to the upstream project.
[documentation]: https://gohugo.io/overview/introduction/ [documentation]: https://gohugo.io/overview/introduction/
[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages [userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages
[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-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