From 2fffd04bd124ee393af4e1ebad7bedbac311c4d2 Mon Sep 17 00:00:00 2001 From: Martin Danielsson Date: Mon, 15 Feb 2016 10:55:50 +0100 Subject: [PATCH] How to set up jekyll on Mac OS X for local testing --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index bffa48f..f11fa10 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ The short version of it is to simply clone this repo into (a) a repo of your own Support for Categories and Tags were inspired by [this blog entry](http://www.minddust.com/post/tags-and-categories-on-github-pages/). A list of the defined categories and tags can be found at `_data/categories.yml` and `_data\tags.yml` respectively. If you want to add new categories or tags, you need to add them to the corresponding `.yml` file and add the matching template into the `meta/category` or `meta/tag` directories. Please do not go overboard with adding new categories and tags but try to stay within the ones we have. On the other hand - if you feel strongly about adding one, feel free to submit a pull request. If you want to find out more about using `github-pages` for blogging or want to improve our blog the following links might be good starting points + * [Jekyll documentation, i.e. how to include images](http://jekyllrb.com/docs/posts/) * [Github pages powered by Jekyll](https://github.com/jekyll/jekyll/wiki/sites) * Liquid Documentation [here](https://docs.shopify.com/themes/liquid-documentation/basics) and [here](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers) @@ -18,3 +19,40 @@ Please note to set the proxy if you are working from within the Haufe Intranet If you find bugs or issues you can [open an issue](https://github.com/Haufe-Lexware/Haufe-Lexware.github.io/issues/new) describing the problem that you're looking to resolve and we'll go from there. +### Setting up jekyll on Mac OS X + +If you happen to have Mac OS X device, it is a lot simpler to test your additions using the `jekyll` command line directly; you don't have to set up github pages, and you can still verify everything is fine. + +To install `jekyll`, issue the following command in Terminal: + +``` +$ sudo gem install jekyll +``` + +That will take a while. After that, `cd` into your `Haufe-Lexware.github.io` git clone (on your own fork obviously) and issue a + +``` +$ jekyll build +``` + +This will throw a couple of errors due to missing gems; install them one after the other in the order they occur: + +``` +$ sudo gem install jekyll-paginate +$ ... +``` + +Eventually (and hopefully) your `jekyll build` will succeed. After the build has succeeded, you can do a `jekyll serve`, and after that, you can browse the site locally on [`http://127.0.0.1:4000`](http://127.0.0.1:4000). + +**Note**: The `https_proxy` setting is also needed on Mac OS X if you're inside the Haufe intranet: + +``` +$ export http_proxy=http://10.12.1.236:8083 +$ export https_proxy=https://10.12.1.236:8083 +``` + +### Setting up jekyll on Windows + +The short version of this is: It's complicated, and not actually advisable. + +The most promising path to doing this is most probably to set up a Linux VM and do it from there; that involves setting up ruby correctly, which may also be challenging, but it's still a lot simpler (and more supported) than directly on Windows. \ No newline at end of file