nikola

nikola

Example Nikola site using GitLab Pages: https://pages.gitlab.io/nikola

Build Status

Example nikola website 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

GitLab CI

This project's static Pages are built by GitLab CI, following the steps defined in .gitlab-ci.yml:

image: paddyhack/nikola

test:
  script:
  - nikola build
  except:
  - master

pages:
  script:
    - nikola build
  artifacts:
    paths:
    - public
  only:
  - master

This basically means: use the paddyhack/nikola image, which will install Nikola with all its features ("nikola [extras]"), and build the site.

Building locally

To work locally with this project, you'll have to follow the steps below:

  1. Fork, clone or download this project
  2. Install Nikola
  3. Generate the website: nikola build
  4. Preview your project: nikola serve
  5. Add content

Read more at Nikola's documentation.

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 and project Pages.

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


Forked from @sukiletxe