Skip to content

Latest commit

 

History

History
126 lines (85 loc) · 6.1 KB

README.md

File metadata and controls

126 lines (85 loc) · 6.1 KB
Raw

Chulapa live preview

GitHub release (latest by date) GitHub Jekyll Bootstrap Fontawesome Algolia lunr mathjax GHpages google-analytics disqus social sharing seo video ko-fi

Chulapa

A full flexible Jekyll theme for Github Pages

Notable features

  • Bootstrap 4 - Fully responsive
  • Fontawesome 5 - 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
  • 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 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

A. Remote theme method

By using jekyll-remote-theme your repo would have remote access to the content of these folders:

  • assets
  • _layouts
  • _includes
  • _sass

This method allows you to get updates easily

Fresh start

Create a Github account, go to chulapa-101 repo, fork it and quickstart your site!

Migrate

You can migrate an existing page adding this line to your _config.yml and make sure to remove any previous theme or remote theme parameter:

remote_theme: dieghernan/chulapa

... more config options

B. Fork the base repository [Advance users only]

You can fork the base repo and modify it. However, the site would be frozen at the moment of forking and it would make harder for you to get potential new features and upgrades.

The minimal files and folders you need are:

  • assets
  • _layouts
  • _includes
  • _sass
  • Gemfile
  • _config.yml

Sample _config file here.

Configuration and Layouts

You have available an extensive documentation here

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 5.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.