dieghernan/chulapa

A full flexible Jekyll Theme for GitHub Pages

Chulapa

A full flexible Jekyll theme for Github Pages

Notable features

• Bootstrap 4 - Fully responsive
• Fontawesome 6 - v5 also supported. v4 is supported via shims but would be deprecated at some point
• 3 different navbar styles
• Atom and RSS 2.0 feed
• Internal search by Algolia, Lunr or Google Custom Search
• Comments by Disqus and Giscus
• Masonry gallery
• Video support - self-hosted or from core providers: Youtube, Vimeo, DailyMotion...
• Structured data for better SEO
• Code highlight - +20 Pygment styles
• Mathjax inside
• Google Analytics
• Twitter/X Cards and Open Graph data valid for Facebook, LinkedIn and WhatsApp
• 14+ preinstalled skins
• Powerful look-and-feel customization with a dedicated sandbox
• Archive, cloud tag and index special layouts
• Do you like breadcrumbs? We have it.
• Multiple authors with location, picture and social links. Travel blogs and colaborative sites welcome!

A great alternative for blogs, news, portfolios and personal sites. Want to know more? Go to Docs.

Installation

Sample _config file here.

There are three possible ways for installing Chulapa:

A. Use our Github Template

Recommended if your are starting from scratch.

Create a Github account, click this link and quickstart your site!

B. Remote theme method

Recommended if you are migrating a previous 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 go to an existing one

2. Add this line to your _config.yml:

   remote_theme: dieghernan/chulapa
   
   ... more config options

3. Remove other remote_theme/theme instances of your _config.yml file.

C. Gem-based method 💎

With Gem-based themes, directories such as the assets, _layouts, _includes, and _sass are stored in the theme's gem, hidden from your immediate view. This allows for easier installation and updating as you don't have to manage any of the theme files.

To install as a Gem-based theme:

1. Add the following to your Gemfile:

   gem "chulapa-jekyll"

2. Fetch and update bundled gems by running the following Bundler command:

   bundle

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

   theme: chulapa-jekyll

To update the theme run bundle update.

Configuration and Layouts

You have available an extensive documentation here

Performance

License

The MIT License

Attributions

Chulapa is a font owned by the City Council of Madrid designed and produced by Joancarles Casasín y Pablo Gámez on a previous design of Silvia Fernández Palomar licensed under Creative Commons CC BY, Versión 4.0. This theme incorporates a modification of this work in order to provide support to the english language.

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

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

This theme incorporates some pieces of 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 and it's 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 Unplash.

This theme uses graphic resources from Pexels.

This theme uses graphic resources from Lorem Picsum.