README.md 2.08 KB
Newer Older
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
1
2
3
Example plain HTML site using GitLab Pages.

Learn more about GitLab Pages at https://pages.gitlab.io and the official
4
documentation https://docs.gitlab.com/ce/user/project/pages/.
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

---

<!-- 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):

```
25
26
image: alpine:latest

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
27
28
29
pages:
  stage: deploy
  script:
30
  - echo 'Nothing to do...'
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
31
32
33
34
35
36
37
  artifacts:
    paths:
    - public
  only:
  - master
```

38
39
The above example expects to put all your HTML files in the `public/` directory.

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
## 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
winniehell's avatar
winniehell committed
58
   HTML files. Have a look at the [index.html] for an example.
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
59
60

[ci]: https://about.gitlab.com/gitlab-ci/
winniehell's avatar
winniehell committed
61
[index.html]: https://gitlab.com/pages/plain-html/blob/master/public/index.html
62
63
[userpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages
[projpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages