Choose from 40+ skins, customize colors from YAML and publish with GitHub Pages. Start with the ready-to-publish blog template, then add the features you need.
Publish your first site · Browse skins · See real sites
Choose the route that matches your situation:
| Your goal | Start here |
|---|---|
| Publish your first website | Browser-only publishing tutorial, using the chulapa-101 template; no local installation needed. |
| Move an existing Jekyll site | Migration guide and checklist, preserving your content and public URLs. |
| Change something on a published site | How-To Guides for individual tasks. |
| Look up a setting or layout | Reference for options, syntax and constraints. |
| Understand how publishing works | Publishing explained. |
The chulapa-101 starter is a ready-to-publish personal blog. Explore its live site or look up its included files and defaults in the starter reference.
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 minimal example includes configuration, dependencies and editable content. They are smaller examples, not the ready-to-publish chulapa-101 template. Run and publish a copied example if you already use Jekyll. Examples follow the default branch; Mermaid requires development changes after v2.1.0.
- Responsive design for phones, tablets and desktops
- Icons for menus, links and content
- 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
- Search and sharing metadata generated from your content
- Styles for code blocks
- Mathematical notation with MathJax
- Mermaid diagrams - optional per-page rendering (development version after v2.1.0)
- Light/dark/auto selector - optional second skin with remembered preferences (2.2.0, unreleased)
- PhotoSwipe galleries - opt-in lightboxes for masonry and carousels (v2.1.1-dev, available on
main; not in v2.1.0) - Active TOC sections - current-section indicators while scrolling (v2.1.1-dev, available on
main; not in v2.1.0) - Google Analytics and GoatCounter - GoatCounter is optional and production-only (v2.1.1-dev, available on
main; not in v2.1.0) - 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 directory to learn more.
The next release candidate is 2.2.0, not yet published. Documentation labels
v2.1.1-dev identify development features planned for that release; they remain
unavailable in the published v2.1.0 gem and remote-theme tag.
Choose an installation guide for your situation. For version pins and method constraints, use Installation.
For a new site, follow Publish your first site. It uses the GitHub template and guides you through editing and publication in your browser.
For an existing site, use the migration guide
or go directly to remote-theme setup.
An unpinned remote theme follows development; @v2.1.0 selects that release.
For a gem-based site, follow Install the theme gem for dependencies, configuration, local preview and updates. Review existing local overrides when upgrading: they take precedence over installed theme files.
Use the documentation directory to choose a tutorial, task guide, reference or explanation. Configuration lookup: Global settings, layouts and snippets, and the sample configuration. Add optional integrations when you need them.
For a published site, follow the accessibility and performance checks. Behavior and release limits are listed separately in the accessibility reference.
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.
