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
$ jekyll serve
For more details read about Jekyll on its web page.
Some important configuration can be done in the file
_config.yml. Please, check the Setup section in that file.
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 "".
Bug reports and pull requests are welcome on GitHub at https://github.com/pietromenna/jekyll-cayman-theme.
To set up your environment to develop this theme, run
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.
This work is licensed under a Creative Commons Attribution 4.0 International license.