README.md 2.59 KB
Newer Older
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
1
2
3
4
5
6
![Build Status](https://gitlab.com/pages/pelican/badges/master/build.svg)

----

Example [Pelican] website using GitLab Pages.

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
7
Learn more about GitLab Pages at https://pages.gitlab.io and the official
8
documentation https://docs.gitlab.com/ce/user/project/pages/.
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
9

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
---

<!-- 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)
- [Building locally](#building-locally)
- [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):

```
image: python:2.7-alpine

pages:
  script:
  - pip install -r requirements.txt
  - pelican -s publishconf.py
  artifacts:
    paths:
    - public/
```
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
40
41
42

## Building locally

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
43
To work locally with this project, you'll have to follow the steps below:
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
44
45

1. Fork, clone or download this project
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
46
1. [Install][] Pelican
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
47
48
49
50
51
52
1. Generate the website: `make html`
1. Preview your project: `make serve`
1. Add content

Read more at Pelican's [documentation].

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
53
## GitLab User or Group Pages
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
54
55
56
57
58
59

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**.

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
60
61
62
Read more about [user/group Pages][userpages] and [project Pages][projpages].

## Did you fork this project?
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
63
64
65
66
67

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.

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
68
69
70
71
72
73
74
## Troubleshooting

1. CSS is missing! That means two things:

    Either that you have wrongly set up the CSS URL in your templates, or
    your static generator has a configuration option that needs to be explicitly
    set in order to serve static assets under a relative URL.
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
75

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
76
[ci]: https://about.gitlab.com/gitlab-ci/
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
77
78
79
[pelican]: http://blog.getpelican.com/
[install]: http://docs.getpelican.com/en/3.6.3/install.html
[documentation]: http://docs.getpelican.com/
80
81
[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