diff --git a/README.md b/README.md index 0eafadc..7700f25 100644 --- a/README.md +++ b/README.md @@ -1 +1,64 @@ -Example plain HTML site using GitLab Pages. Read more at https://doc.gitlab.com/ee/pages/ \ No newline at end of file +![Build Status](https://gitlab.com/pages/plain-html/badges/master/build.svg) + +--- + +Example plain HTML site using GitLab Pages. + +Learn more about GitLab Pages at https://pages.gitlab.io and the official +documentation http://doc.gitlab.com/ee/pages/README.html. + +--- + + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [GitLab CI](#gitlab-ci) +- [GitLab User or Group Pages](#gitlab-user-or-group-pages) +- [Did you fork this project?](#did-you-fork-this-project) +- [Troubleshooting](#troubleshooting) + + + +## GitLab CI + +This project's static Pages are built by [GitLab CI][ci], following the steps +defined in [`.gitlab-ci.yml`](.gitlab-ci.yml): + +``` +pages: + stage: deploy + script: + - mkdir .public + - cp -r * .public + - mv .public public + artifacts: + paths: + - public + only: + - master +``` + +## 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**. + +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 that you have wrongly set up the CSS URL in your + HTML files. + +[ci]: https://about.gitlab.com/gitlab-ci/ +[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages +[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages