diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-04-05 23:28:25 +0300 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-04-05 23:28:25 +0300 |
| commit | ceb3785a5a7c509b5a8b00be68d0c16a74dac31f (patch) | |
| tree | 51cc1099914637bbeab022c38b733906557a89d6 /README.md | |
| parent | Add .gitlab-ci.yml. (diff) | |
| download | pages-plain-html-ceb3785a5a7c509b5a8b00be68d0c16a74dac31f.tar.gz | |
Update README
Diffstat (limited to '')
| -rw-r--r-- | README.md | 65 |
1 files changed, 64 insertions, 1 deletions
@@ -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 + + +--- + +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. + +--- + +<!-- 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)* + +- [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) + +<!-- END doctoc generated TOC please keep comment here to allow auto update --> + +## 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 |