From ea700582766fd8e861278ad58e468cfe5d6fd1c3 Mon Sep 17 00:00:00 2001 From: Virtua Creative Date: Thu, 24 Mar 2016 19:05:09 -0300 Subject: [PATCH] updating readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 75342c8..7a61775 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ---- -View site: https://pages.gitlab.io/jekyll/ +Example [Jekyll] site using GitLab Pages. Read more at https://doc.gitlab.com/ee/pages/ ----- # Theme: Jekyll 3 Default @@ -28,6 +28,14 @@ To work locally with this project, there are a few options. But let's keep it si - Adjust [`_config.yml`] according to your project - Preview your project: `jekyll serve` +# GitLab User or Group Page + +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 `Project` -> `Settings`. + +# Forked projects + +If you forked this project for your own use, please go to `Project` -> `Settings` and remove the forking relationship, which won't be necessary in this case. + [Jekyll]: http://jekyllrb.com/ [jek-312]: https://rubygems.org/gems/jekyll/versions/3.1.2 [`_config.yml`]: https://gitlab.com/jekyll-themes/default-bundler/blob/master/_config.yml