Table of Contents generated with DocToc
- Getting Started
- GitLab CI
- Using Jekyll locally
- GitLab User or Group Pages
- Did you fork this project?
- Other examples
You can get started with GitLab Pages using Jekyll easily by either forking this repository or by uploading a new/existing Jekyll project.
Remember you need to wait for your site to build before you will be able to see your changes. You can track the build on the Pipelines tab.
Start by forking this repository
- Fork this repository.
IMPORTANT: Remove the fork relationship.
Go to Settings (
⚙) > Edit Project and click the "Remove fork relationship" button.
- Enable Shared Runners.
Go to Settings (
⚙) > Pipelines and click the "Enable shared Runners" button.
- Rename the repository to match the name you want for your site.
- Edit your website through GitLab or clone the repository and push your changes.
Start from a local Jekyll project
- Install Jekyll.
jekyll newto create a new Jekyll Project.
- Add this
.gitlab-ci.ymlto the root of your project.
- Push your repository and changes to GitLab.
image: ruby:latest variables: JEKYLL_ENV: production pages: script: - bundle install - bundle exec jekyll build -d public artifacts: paths: - public only: - master
Using Jekyll locally
To work locally with this project, you'll have to follow the steps below:
- Fork, clone or download this project
- Install Jekyll
- Download dependencies:
- Build and preview:
bundle exec jekyll serve
- Add content
The above commands should be executed from the root directory of this project.
Read more at Jekyll'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
groupname. This can be done by navigating to your
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.
- jekyll-branched demonstrates how you can keep your GitLab Pages site in one branch and your project's source code in another.
- The jekyll-themes group contains a collection of example projects you can fork (like this one) having different visual styles.
- 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.