Alembic

Theme by Daviddarnes

|

Updated: 26 Dec 2024

|

812 Stars

A Jekyll boilerplate theme designed to be a starting point for any Jekyll website

Categories

Overview

Alembic is a Jekyll boilerplate theme designed to be a starting point for any Jekyll website. It is a clear and elegant theme that can be used out of the box or customized as needed. It has been tested in all major browsers and includes features such as a built-in Service Worker for offline functionality, configurable colors and typography, extensive set of shortcodes, and modular Jekyll components.

Features

• Available as a theme gem and GitHub Pages theme
• Clear and elegant design that can be used out of the box or as a solid starting point
• Tested in all major browsers, including IE and Edge
• Built-in Service Worker for offline functionality and slow connections
• Configurable colors and typography in a single settings file
• Extensive set of shortcodes for various elements
• Solid typographic framework from Sassline
• Configurable navigation via a single file
• Modular Jekyll components
• Post category support with a single post index page grouped by category
• Built-in live search using JavaScript
• Contact form built-in using Formspree or Netlify Forms
• Designed with Siteleaf in mind
• Popular networks as performant sharing buttons
• Documentation available

Installation

Quick setup

• Vanilla Jekyll starter kit: Download kit
• Forestry starter kit: Deploy to Forestry
• Netlify CMS starter kit: Deploy to Netlify
• GitHub Pages with remote theme kit: Download kit
• Stackbit starter kit: Create with Stackbit

As a Jekyll theme

1. Add gem "alembic-jekyll-theme" to your Gemfile to add the theme as a dependency.
2. Run the command bundle install in the root of project to install the theme and its dependencies.
3. Add theme: alembic-jekyll-theme to your _config.yml file to set the site theme.
4. Run bundle exec jekyll serve to build and serve your site.
5. Use the configuration documentation and the example _config.yml file to customize navigation, contact form, and social sharing buttons.

As a GitHub Pages remote theme

1. Add gem "jekyll-remote-theme" to your Gemfile to add the theme as a dependency.
2. Run the command bundle install in the root of project to install the jekyll remote theme gem as a dependency.
3. Add jekyll-remote-theme to the list of plugins in your _config.yml file.
4. Add remote_theme: daviddarnes/alembic@main to your _config.yml file to set the site theme.
5. Run bundle exec jekyll serve to build and serve your site.
6. Use the configuration documentation and the example _config.yml file to customize navigation, contact form, and social sharing buttons.

As a Boilerplate / Fork (deprecated, not recommended)

• Fork the repo
• Replace the Gemfile

Summary

Alembic is a versatile Jekyll boilerplate theme with a clear and elegant design. It offers extensive customization options, including configurable colors and typography, modular components, and various shortcodes for easy inclusion of elements. It is compatible with major browsers and can be used as a theme gem or a GitHub Pages theme. The theme also includes built-in functionality for offline access, live search, and contact forms. With its ease of installation and documentation, Alembic provides a solid starting point for any Jekyll project.