---

Example ikiwiki website using GitLab Pages.

Learn more about GitLab Pages at https://pages.gitlab.io and the official documentation https://docs.gitlab.com/ce/user/project/pages/.

---

Table of Contents generated with DocToc

• GitLab CI
• Building locally
• GitLab User or Group Pages
• Did you fork this project?
• Troubleshooting

GitLab CI

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

image: elecnix/ikiwiki

before_script:
  - apt-get install -y git
  - git submodule init
  - git submodule update

test:
  stage: test
  script:
  - ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib
  only:
  - branches
  - tags

pages:
  stage: deploy
  script:
  - ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib
  artifacts:
    paths:
    - public
  only:
  - master

We are using a theme based on Bootstrap 4 using submodules, and in order to enable the theme plugin, we must pass the libdir parameter.

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 ikiwiki
3. Clone the submodules: git submodule init && git submodule update
4. Generate the website: ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib
5. Preview your project: open public/index.html in a browser

Read more at ikiwiki'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.