Top Related Projects
The Jekyll Butler. A no frills responsive Jekyll blog theme.
:triangular_ruler: Jekyll theme for building a personal site, blog, project documentation, or portfolio.
Build a Jekyll blog in minutes, without touching the command line.
✨ Build a beautiful and simple website in literally minutes. Demo at https://beautifuljekyll.com
Minima is a one-size-fits-all Jekyll theme for writers.
Github Pages template for academic personal websites, forked from mmistakes/minimal-mistakes
Quick Overview
Cayman is a Jekyll theme for GitHub Pages. It provides a clean, responsive design that's easy to customize and use for project websites, documentation, or personal blogs hosted on GitHub Pages.
Pros
- Simple and elegant design out of the box
- Responsive layout that works well on various devices
- Easy to customize with minimal CSS changes
- Seamless integration with GitHub Pages
Cons
- Limited built-in features compared to more complex themes
- May require additional customization for advanced layouts
- Not suitable for complex websites with multiple page types
- Limited navigation options without manual customization
Getting Started
To use the Cayman theme with your GitHub Pages site:
- Add the following to your site's
_config.yml
:
remote_theme: pages-themes/cayman@v0.2.0
plugins:
- jekyll-remote-theme
- Optionally, if you'd like to preview your site on your computer, add the following to your site's
Gemfile
:
gem "github-pages", group: :jekyll_plugins
- Create or update your site's
index.md
with your desired content:
---
layout: default
---
# Welcome to my website
This is a sample page using the Cayman theme.
-
Run
bundle install
to install the necessary dependencies. -
Run
bundle exec jekyll serve
to start the preview server. -
Visit
localhost:4000
in your browser to preview your site.
For more detailed instructions and customization options, refer to the Cayman theme documentation.
Competitor Comparisons
The Jekyll Butler. A no frills responsive Jekyll blog theme.
Pros of Poole
- More customizable and flexible, offering a foundation for building Jekyll themes
- Includes two pre-built themes (Hyde and Lanyon) for quick setup
- Provides a more comprehensive starting point for Jekyll projects
Cons of Poole
- Requires more setup and configuration compared to Cayman
- Less frequently updated, with the last commit being older than Cayman's
- May have a steeper learning curve for beginners
Code Comparison
Poole (_config.yml):
permalink: pretty
relative_permalinks: true
title: Poole
tagline: 'The Jekyll Butler'
description: 'Base theme for Jekyll themes by @mdo.'
url: http://getpoole.com
Cayman (_config.yml):
title: Cayman theme
description: Cayman is a clean, responsive theme for GitHub Pages.
show_downloads: true
google_analytics:
theme: jekyll-theme-cayman
Poole offers more configuration options out of the box, while Cayman provides a simpler setup focused on essential elements. Poole's configuration includes additional features like permalinks and taglines, whereas Cayman's configuration is more streamlined and tailored for GitHub Pages.
:triangular_ruler: Jekyll theme for building a personal site, blog, project documentation, or portfolio.
Pros of Minimal Mistakes
- More feature-rich and customizable theme with extensive documentation
- Supports multiple authors, layouts, and skins out of the box
- Includes built-in SEO optimization and social sharing features
Cons of Minimal Mistakes
- Steeper learning curve due to more complex structure and options
- Requires more setup and configuration compared to simpler themes
- May be overkill for basic websites or blogs
Code Comparison
Minimal Mistakes (_config.yml):
minimal_mistakes_skin: "default"
locale: "en-US"
title: "My Website"
subtitle: "A custom subtitle"
name: "Your Name"
description: "An amazing website."
Cayman (_config.yml):
title: My Project
description: This is a great project
show_downloads: true
google_analytics: UA-XXXXXXXX-X
theme: jekyll-theme-cayman
Minimal Mistakes offers more configuration options and customization in its default _config.yml file, while Cayman provides a simpler setup with fewer options. This reflects the overall difference in complexity and flexibility between the two themes.
Build a Jekyll blog in minutes, without touching the command line.
Pros of jekyll-now
- Easier setup for beginners with a more comprehensive starter template
- Includes pre-configured social media integration and commenting system
- Provides a more complete blog structure out-of-the-box
Cons of jekyll-now
- Less flexible for customization compared to Cayman's minimalist approach
- May require more cleanup for users who want a simpler site structure
- Less frequently updated, potentially leading to outdated dependencies
Code Comparison
jekyll-now:
name: Your Name
description: Web Developer from Somewhere
avatar: https://raw.githubusercontent.com/barryclark/jekyll-now/master/images/jekyll-logo.png
footer-links:
dribbble:
email:
facebook:
flickr:
Cayman:
title: Cayman theme
description: Cayman is a clean, responsive theme for GitHub Pages.
show_downloads: true
google_analytics:
theme: jekyll-theme-cayman
The jekyll-now configuration includes more pre-defined options for social media and site customization, while Cayman's configuration is more streamlined and focused on essential theme settings. jekyll-now provides a more comprehensive starting point for bloggers, whereas Cayman offers a cleaner slate for developers who prefer to build from a minimal base.
✨ Build a beautiful and simple website in literally minutes. Demo at https://beautifuljekyll.com
Pros of Beautiful Jekyll
- More feature-rich with built-in support for comments, analytics, and social sharing
- Highly customizable with numerous configuration options
- Includes ready-to-use layouts for various page types (e.g., blog posts, projects)
Cons of Beautiful Jekyll
- Steeper learning curve due to more complex structure and configuration
- Requires more setup time compared to Cayman's simplicity
- May be overkill for simple, single-page websites
Code Comparison
Beautiful Jekyll configuration example:
title: My Website
author: John Doe
navbar-links:
About Me: "aboutme"
Resources:
- Beautiful Jekyll: "https://beautifuljekyll.com"
- Learn markdown: "https://www.markdowntutorial.com/"
Cayman configuration example:
title: My Website
description: A simple website using Cayman theme
show_downloads: true
google_analytics: UA-XXXXXXXX-X
Beautiful Jekyll offers more extensive configuration options, while Cayman keeps it simple with fewer, essential settings. Beautiful Jekyll is better suited for complex websites with multiple pages and features, whereas Cayman is ideal for straightforward, single-page sites or project documentation.
Minima is a one-size-fits-all Jekyll theme for writers.
Pros of Minima
- More customizable with multiple layouts and includes
- Supports blog functionality out of the box
- Includes social media integration and RSS feed support
Cons of Minima
- Slightly more complex setup and configuration
- May require more CSS customization for unique designs
- Larger file size due to additional features
Code Comparison
Minima (default layout):
<!DOCTYPE html>
<html lang="{{ page.lang | default: site.lang | default: "en" }}">
{%- include head.html -%}
<body>
{%- include header.html -%}
<main class="page-content" aria-label="Content">
<div class="wrapper">
{{ content }}
</div>
</main>
{%- include footer.html -%}
</body>
</html>
Cayman (default layout):
<!DOCTYPE html>
<html lang="{{ site.lang | default: "en-US" }}">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
{% seo %}
<link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
</head>
<body>
<div class="container-lg px-3 my-5 markdown-body">
{{ content }}
</div>
</body>
</html>
Github Pages template for academic personal websites, forked from mmistakes/minimal-mistakes
Pros of academicpages
- Specifically designed for academic personal websites
- Includes templates for publications, talks, and teaching
- More comprehensive and feature-rich for academic purposes
Cons of academicpages
- More complex setup and customization process
- Potentially overwhelming for users seeking a simple theme
- Less frequently updated compared to Cayman
Code Comparison
academicpages:
# Site Settings
locale: "en-US"
title: "Your Name / Site Title"
title_separator: "-"
name: "Your Name"
description: "personal description"
url: # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
baseurl: "" # the subpath of your site, e.g. "/blog"
Cayman:
title: Cayman theme
description: Cayman is a clean, responsive theme for GitHub Pages.
show_downloads: true
google_analytics:
theme: jekyll-theme-cayman
The academicpages configuration offers more detailed settings for an academic website, while Cayman's configuration is simpler and more general-purpose.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
The Cayman theme
Cayman is a Jekyll theme for GitHub Pages. You can preview the theme to see what it looks like, or even use it today.
Usage
To use the Cayman theme:
-
Add the following to your site's
_config.yml
:remote_theme: pages-themes/cayman@v0.2.0 plugins: - jekyll-remote-theme # add this line to the plugins list if you already have one
-
Optionally, if you'd like to preview your site on your computer, add the following to your site's
Gemfile
:gem "github-pages", group: :jekyll_plugins
Customizing
Configuration variables
Cayman will respect the following variables, if set in your site's _config.yml
:
title: [The title of your site]
description: [A short description of your site's purpose]
Additionally, you may choose to set the following optional variables:
show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics: [Your Google Analytics tracking ID]
Stylesheet
If you'd like to add your own custom styles:
- Create a file called
/assets/css/style.scss
in your site - Add the following content to the top of the file, exactly as shown:
--- --- @import "{{ site.theme }}";
- Add any custom CSS (or Sass, including imports) you'd like immediately after the
@import
line
Note: If you'd like to change the theme's Sass variables, you must set new values before the @import
line in your stylesheet.
Layouts
If you'd like to change the theme's HTML layout:
- For some changes such as a custom
favicon
, you can add custom files in your local_includes
folder. The files provided with the theme provide a starting point and are included by the original layout template. - For more extensive changes, copy the original template from the theme's repository
(Pro-tip: click "raw" to make copying easier) - Create a file called
/_layouts/default.html
in your site - Paste the default layout content copied in the first step
- Customize the layout as you'd like
Customizing Google Analytics code
Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into _includes/head-custom-google-analytics.html
in your Jekyll site.
Overriding GitHub-generated URLs
Templates often rely on URLs supplied by GitHub such as links to your repository or links to download your project. If you'd like to override one or more default URLs:
- Look at the template source to determine the name of the variable. It will be in the form of
{{ site.github.zip_url }}
. - Specify the URL that you'd like the template to use in your site's
_config.yml
. For example, if the variable wassite.github.url
, you'd add the following:github: zip_url: http://example.com/download.zip another_url: another value
- When your site is built, Jekyll will use the URL you specified, rather than the default one provided by GitHub.
Note: You must remove the site.
prefix, and each variable name (after the github.
) should be indent with two space below github:
.
For more information, see the Jekyll variables documentation.
Roadmap
See the open issues for a list of proposed features (and known issues).
Project philosophy
The Cayman theme is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.
Contributing
Interested in contributing to Cayman? We'd love your help. Cayman is an open source project, built one contribution at a time by users like you. See the CONTRIBUTING file for instructions on how to contribute.
Previewing the theme locally
If you'd like to preview the theme locally (for example, in the process of proposing a change):
- Clone down the theme's repository (
git clone https://github.com/pages-themes/cayman
) cd
into the theme's directory- Run
script/bootstrap
to install the necessary dependencies - Run
bundle exec jekyll serve
to start the preview server - Visit
localhost:4000
in your browser to preview the theme
Running tests
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run script/cibuild
. You'll need to run script/bootstrap
once before the test script will work.
Top Related Projects
The Jekyll Butler. A no frills responsive Jekyll blog theme.
:triangular_ruler: Jekyll theme for building a personal site, blog, project documentation, or portfolio.
Build a Jekyll blog in minutes, without touching the command line.
✨ Build a beautiful and simple website in literally minutes. Demo at https://beautifuljekyll.com
Minima is a one-size-fits-all Jekyll theme for writers.
Github Pages template for academic personal websites, forked from mmistakes/minimal-mistakes
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot