/jekyll-cayman-theme

A Jekyll theme for the responsive theme for GitHub Pages http://jasonlong.github.io/cayman-theme/

Primary LanguageCSS

Jekyll Cayman theme

This is a Jekyll theme for @jasonlong's Cayman theme on GitHub Pages.

Cayman is a clean, responsive theme for GitHub Pages. This theme is available as an option if you use the Automatic Page Generator or you can copy the template and styles to use on your own.

You can preview the theme at http://jasonlong.github.io/cayman-theme or with real content at http://jasonlong.github.io/geo_pattern.

How to use it?

Download the theme @ http://github.com/pietromenna/jekyll-cayman-theme/archive/master.zip

Unzip it and use it as a regular jekyll folder.

$ unzip master.zip

Get inside the newly extracted folder

$ cd jekyll-cayman-theme

Get the required gems

$ bundle install

Use it!

$ jekyll serve

For more details read about Jekyll on its web page.

Setup

Some important configuration can be done in file _config.yml. Please, chec the Setup setion in this file.

baseurl

baseurl parameter is required in the case the site doesn't sit on the root of the domain. For example: http://pietromenna.github.io/jekyll-cayman-theme

In the case above the baseurl should be set to "/jekyll-cayman-theme".

In the case the site sits in the root, you can leave baseurl as empty "".

License

This work is licensed under a Creative Commons Attribution 4.0 International license.