Skip to content
A Jekyll theme for the responsive theme for GitHub Pages http://jasonlong.github.io/cayman-theme/
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes Remove author and link Dec 13, 2016
_layouts Add locale to possible configurations Dec 6, 2017
_posts Initial commit Feb 12, 2016
css Fixing syntax by copying new version of css Feb 5, 2017
.gitignore Changes for Jekyll theme gem Aug 13, 2016
Gemfile
README.md HTTPS relevant links Jan 12, 2018
_config.yml Add locale to possible configurations Dec 6, 2017
index.html Initial commit Feb 12, 2016
jekyll-cayman-theme.gemspec Removed Gemfile.lock Aug 13, 2016

README.md

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 https://jasonlong.github.io/cayman-theme or with real content at https://jasonlong.github.io/geo_pattern.

How to use it?

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

Unzip it and use it as a regular jekyll folder.

$ unzip jekyll-cayman-theme-master.zip

Get inside the newly extracted folder

$ cd jekyll-cayman-theme-master

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 the file _config.yml. Please, check the Setup section in that file.

baseurl

baseurl parameter is required in the case the site doesn't sit on the root of the domain. For example: https://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 "".

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pietromenna/jekyll-cayman-theme.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

License

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

You can’t perform that action at this time.