Home Explore Help
Register Sign In
MEDLab
/
excavations-website
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: f2989df305
Branches Tags
excavations-web...
/
README.md

README.md 3.9 KB
History Raw

Build Status Jekyll Version

Example Jekyll 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

Getting Started

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

  1. Fork this repository.
  2. IMPORTANT: Remove the fork relationship. Go to Settings (⚙) > Edit Project and click the "Remove fork relationship" button.
  3. Enable Shared Runners. Go to Settings (⚙) > CI/CD Pipelines and click the "Enable shared Runners" button.
  4. Rename the repository to match the name you want for your site.
  5. Edit your website through GitLab or clone the repository and push your changes.

Start from a local Jekyll project

  1. Install Jekyll.
  2. Use jekyll new to create a new Jekyll Project.
  3. Add this .gitlab-ci.yml to the root of your project.
  4. Push your repository and changes to GitLab.

GitLab CI

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

image: ruby:2.3

variables:
  JEKYLL_ENV: production

pages:
  script:
  - gem install jekyll
  - jekyll build -d public
  artifacts:
    paths:
    - public
  only:
  - master

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 Jekyll
  3. Generate the website: jekyll build -d public
  4. Preview your project: jekyll serve
  5. Add content

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