From f58aedc31d79e588c3c6bc1c2019ae26638bf41c Mon Sep 17 00:00:00 2001 From: Adam Voss Date: Fri, 10 Mar 2017 14:18:45 -0600 Subject: [PATCH 1/2] Updated README to consistently use bundle --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 657b5a4..58b9440 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ documentation https://docs.gitlab.com/ce/user/project/pages/. - [Start by forking this repository](#start-by-forking-this-repository) - [Start from a local Jekyll project](#start-from-a-local-jekyll-project) - [GitLab CI](#gitlab-ci) -- [Building locally](#building-locally) +- [Using Jekyll locally](#using-jekyll-locally) - [GitLab User or Group Pages](#gitlab-user-or-group-pages) - [Did you fork this project?](#did-you-fork-this-project) - [Troubleshooting](#troubleshooting) @@ -61,8 +61,8 @@ variables: pages: script: - - gem install jekyll - - jekyll build -d public + - bundle install + - bundle exec jekyll build -d public artifacts: paths: - public @@ -70,16 +70,18 @@ pages: - master ``` -## Building locally +## Using Jekyll locally To work locally with this project, you'll have to follow the steps below: 1. Fork, clone or download this project 1. [Install][] Jekyll -1. Generate the website: `jekyll build -d public` -1. Preview your project: `jekyll serve` +1. Download dependencies: `bundle` +1. Build and preview: `bundle exec jekyll serve` 1. 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 From 400fd40cfc12489be295874b55b2822cb38d374c Mon Sep 17 00:00:00 2001 From: Adam Voss Date: Fri, 10 Mar 2017 14:20:13 -0600 Subject: [PATCH 2/2] Miscellaneous improvments to README --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 58b9440..f42f94b 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,9 @@ --- -Example [Jekyll] website using GitLab Pages. +Example [Jekyll] website using GitLab Pages. View it live at https://pages.gitlab.io/jekyll -Learn more about GitLab Pages at https://pages.gitlab.io and the official -documentation https://docs.gitlab.com/ce/user/project/pages/. +[Learn more about GitLab Pages](https://pages.gitlab.io) or read the the [official GitLab Pages documentation](https://docs.gitlab.com/ce/user/project/pages/). --- @@ -21,6 +20,7 @@ documentation https://docs.gitlab.com/ce/user/project/pages/. - [Using Jekyll locally](#using-jekyll-locally) - [GitLab User or Group Pages](#gitlab-user-or-group-pages) - [Did you fork this project?](#did-you-fork-this-project) +- [Other examples](#other-examples) - [Troubleshooting](#troubleshooting) @@ -99,12 +99,16 @@ 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. +## Other examples + +* [jekyll-branched](https://gitlab.com/pages/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](https://gitlab.com/groups/jekyll-themes) group contains a collection of example projects you can fork (like this one) having different visual styles. + ## 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 + * 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. [ci]: https://about.gitlab.com/gitlab-ci/