Overview

The Cayman Blog theme is a Jekyll theme for GitHub Pages. Based on the Cayman theme, it adds blogging features. It is compatible with GitHub Pages but requires a slightly different installation process.

Features

• Based on the Cayman theme with added blogging features
• Compatible with GitHub Pages
• Easy installation process

Installation

Self-hosting (for Jekyll v3.3+)

1. Add this line to your Jekyll site’s Gemfile: gem "jekyll-theme-cayman-blog"
2. Add this line to your Jekyll site’s _config.yml file: theme: jekyll-theme-cayman-blog
3. Run Bundler to install the theme gem and dependencies.

Hosting with GitHub Pages

• Note that GitHub Pages only supports certain gem-based themes.
• To install Cayman Blog Theme on GitHub Pages, you need to install the theme gem and convert it to a regular theme.
• Alternatively, you can fork the entire theme and keep only the necessary files.

Gem Install (preferred method for existing Jekyll blogs)

1. Install the theme gem: gem install jekyll-theme-cayman-blog
2. Run gem env gemdir to determine the installation directory of the gem.
3. Open the gem folder and locate the theme folder (e.g. jekyll-theme-cayman-blog-0.0.5).
4. Copy all the files in the theme folder to your blog folder.
5. Leave the theme field in your site’s _config.yml file empty.
6. Customize the theme by modifying _config.yml, about.md, and contact.md for your project.

Install as a Fork (preferred method for new projects)

1. Fork the Cayman Blog theme repository.
2. Clone the forked repository to your local machine: git clone git@github.com:username/reponame.git
3. Delete the screenshot.png and screenshot-mobile.png files.
4. Empty the _posts folder.
5. Install Bundler and gems using script/bootstrap.
6. Run Jekyll using bundle exec jekyll serve.
7. Customize the theme by modifying _config.yml, about.md, contact.md, and now.md for your project.

Summary

The Cayman Blog theme is a Jekyll theme for GitHub Pages that adds blogging features to the Cayman theme. It can be installed on both self-hosted Jekyll sites and GitHub Pages, although the installation process differs slightly. Self-hosted Jekyll sites can install the theme as a gem, while for GitHub Pages, the theme gem needs to be converted to a regular theme. Alternatively, the theme can be installed by forking the theme repository and customizing the necessary files.