jekyll cayman theme

84 Stars

Theme author

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


Contributing


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


Development


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


You theme is setup just like a normal Jelyll 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.