Chulapa

A flexible, visual Jekyll theme for blogs, portfolios and personal sites

Choose from 40+ skins, customize colors from YAML and publish with GitHub Pages. Start with a small example, then add the features your site needs.

Get started · Browse skins · See real sites

Choose your starting point

For your first site, use chulapa-101, the ready-to-publish personal blog template. It includes three sample posts, a local photograph, About, year, category and tag archives, Fuse.js search, RSS and a paginated home page, using the predefined Gitdev skin. Explore the live starter. Create your repository, enable GitHub Pages with GitHub Actions and edit the site details and sample content. No local installation is required.

For smaller examples of individual site types, explore the folders below:

Site	Complete example	Preview
Personal blog	A journal and recent-post index	Demo
Technical blog	Code, diagrams and equations	Demo
Portfolio	A projects collection and card index	Demo
Project	A landing page with source and setup links	Demo

Each example includes configuration, dependencies and editable content. For a new site with a publishing workflow, use chulapa-101. See the start guide for local preview and publishing. Examples follow the default branch; Mermaid requires development changes after v2.1.0.

Notable features

• Bootstrap 4 - Fully responsive
• Font Awesome 6 - v5 is also supported, with optional v4 shims
• 3 different navbar styles
• Atom and RSS 2.0 feeds
• Internal search by Algolia, Lunr, Fuse.js, Simple-Jekyll-Search or Google Custom Search
• Comments by Disqus, giscus, Cusdis, Cactus and Welcomments
• Masonry gallery
• Video support - self-hosted videos or videos from providers such as YouTube, Vimeo and Dailymotion
• Structured data for better SEO
• Code highlighting - Pygments-compatible styles for Rouge
• MathJax support
• Mermaid diagrams - optional per-page rendering (development version after v2.1.0)
• Google Analytics
• Twitter/X Cards and Open Graph data valid for Facebook, LinkedIn and WhatsApp
• 40+ preinstalled skins
• Powerful look-and-feel customization with a dedicated sandbox
• Archive, tag and category clouds and card index layouts
• Breadcrumb navigation
• Multiple authors with locations, pictures and social links for travel blogs and collaborative sites

A flexible theme for blogs, news sites, portfolios and personal sites. See the documentation to learn more.

Installation

See the accessibility and performance guide for keyboard behavior, color checks and resource loading. These improvements are development changes after v2.1.0.

See the sample _config.yml file.

There are three ways to install Chulapa:

A. Use our GitHub template

Recommended if you are starting from scratch.

Sign in to GitHub and create a repository from the template to get started with an editable personal blog. Choose GitHub Actions in your repository's Settings > Pages, then update the site details in _config.yml and replace the sample content. Follow the starter's setup guide for publishing and local preview.

B. Remote theme method

Recommended if you are migrating an existing site.

If you prefer not to use the template, you can use the jekyll-remote-theme method. Just follow these steps:

1. Create a new GitHub repository or open an existing one.

2. Add this line to your _config.yml:

   remote_theme: dieghernan/chulapa
   
   ... more config options

3. Remove any other remote_theme entry and the theme entry from _config.yml. Add jekyll-remote-theme and jekyll-include-cache to your Gemfile and the plugins list in _config.yml, then run bundle install. Chulapa requires jekyll-include-cache for its include_cached tags.

   For local or custom builds, also install the runtime dependencies listed in the gemspec. A remote theme does not install these dependencies for you.

An unpinned remote theme follows the repository default branch. To select a release, append its tag, for example remote_theme: dieghernan/chulapa@v2.1.0. Development features may be available on the default branch before they are published in the gem.

C. Gem-based method 💎

With gem-based themes, directories such as assets, _layouts, _includes and _sass are stored in the theme's gem rather than your site directory. This makes installation and updates easier because you do not have to manage the theme files directly.

To install as a gem-based theme:

1. Add the following to your Gemfile:

   gem "chulapa-jekyll"

2. Install the bundled gems by running the following Bundler command:

   bundle

3. Set the theme in your project's Jekyll _config.yml file:

   theme: chulapa-jekyll

Enable jekyll-include-cache in the plugins list in _config.yml. Remove any remote_theme entry when using the gem. To update only the theme and its dependencies, run bundle update chulapa-jekyll.

To preview your site locally, run bundle exec jekyll serve from your site directory. Restart Jekyll after editing _config.yml to reload its settings.

Configuration and layouts

See the documentation for installation, configuration, layouts, search, comments and customization. Structured data options include an independent publisher, representative article images through schema_image and per-page crawler directives through robots.

License

The MIT License

Attributions

Chulapa is a font owned by the City Council of Madrid, designed and produced by Joancarles Casasín and Pablo Gámez based on an earlier design by Silvia Fernández Palomar and licensed under Creative Commons CC BY, version 4.0. This theme incorporates a modification of this work to support the English language.

Bootstrap v.4.5 is released under the MIT license and is copyright 2020 Twitter.

Font Awesome 6.x is free, open source and GPL-friendly. See its License (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License).

This theme incorporates code from Minimal Mistakes, Copyright (c) 2013-2020 Michael Rose and contributors distributed under the terms of the MIT license.

This theme incorporates Pygments CSS Themes, developed by jwarby distributed under the terms of The Unlicense.

This theme incorporates Ferpal Sans, developed by Silvia Ferpal. The font is free for personal use.

This theme incorporates Jekyll Pure Liquid Table of Contents, Copyright © 2017 Vladimir "allejo" Jimenez distributed under the terms of the MIT license.

This theme incorporates Compress HTML in Jekyll, Copyright (c) 2014 Anatol Broder distributed under the terms of the MIT license.

This theme incorporates Lunr, Copyright (c) 2013 Oliver Nightingale. Lunr is distributed under the terms of the MIT License.

This theme uses graphic resources from Unsplash.

This theme uses graphic resources from Pexels.

This theme uses graphic resources from Lorem Picsum.