⚗ A Jekyll boilerplate theme designed to be a starting point for any Jekyll website
CSS HTML JavaScript Ruby
Latest commit 80ed8bd Feb 20, 2017 @daviddarnes Tweaks for relevancy #38
Permalink
Failed to load latest commit information.
_includes Clean up sidebar a little, improve sticky category index nav Feb 5, 2017
_layouts fix conflicts Feb 5, 2017
_posts Changes post to test categories page Feb 3, 2017
_sass Moves colours into its own file for better customisation #14 Oct 9, 2016
assets Set search.json to null to stop warnings Feb 5, 2017
blog Changes blog page variable for matching with collection type Oct 10, 2016
demo Add excerpts to all demo and sample page Feb 5, 2017
.gitignore Stops tracking Gemfile.lock files Oct 12, 2016
404.md Adds example content back in, hoping to have the gem and forkable ver… Oct 8, 2016
CNAME Adds domain record back in Oct 8, 2016
CODE_OF_CONDUCT.md Add code of conduct and contributing documents, to be completed #38 Feb 20, 2017
CONTRIBUTING.md Tweaks for relevancy #38 Feb 20, 2017
Gemfile Adds gemfile to refer to the gemspec file, may need changing Oct 12, 2016
LICENSE Initial commit Aug 27, 2016
README.md Remove mention of search.json, no longer needed Feb 5, 2017
_config.yml Add search and categories to nav Feb 5, 2017
alembic-jekyll-theme.gemspec Set search.json to null to stop warnings Feb 5, 2017
categories.md Add excerpts to all demo and sample page Feb 5, 2017
elements.md Add excerpts to all demo and sample page Feb 5, 2017
index.md Add excerpts to all demo and sample page Feb 5, 2017
screenshot.png Removes map from sidebar, makes sidebar less distracting from the mai… Oct 9, 2016
search.md Add excerpts to all demo and sample page Feb 5, 2017

README.md

Alembic

Gem Version

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

Screenshot

Contents

About

Alembic is a starting point for Jekyll projects. Rather than starting from scratch, this boilerplate is designed to get the ball rolling immediately. Install it, configure it, tweak it, push it.

Features

  • Available as a starter kit or as Jekyll 3.3 theme gem
  • Tested in all major browsers, that includes IE as well as Edge
  • Extensive set of shortcodes to include various elements; such as buttons, icons, figure images and more
  • Solid typographic framework from Sassline
  • Configurable navigation via a single file
  • Modular Jekyll components
  • Easily interchangeable sidebar
  • Post category support in the form of a single post index page grouped by category
  • Built in live search using JavaScript
  • Contact form built in using Formspree
  • Works on GitHub Pages out of the box
  • Built with Jekyll 3.3
  • Designed with Siteleaf in mind
  • Has 9 of the most popular networks as performant sharing buttons
  • Has documentation

Examples

Here are a few examples of Alembic out in the wild being used in a variety of ways:

Installation

As a Boilerplate / Fork

  1. Fork the repo
  2. Clone down the repo with $ git clone git@github.com:username/reponame.git
  3. Delete the demo/ folder and screenshot.png files
  4. Change the CNAME record to your projects' record
  5. Install bundler with $ gem install bundler
  6. Install gems with $ bundle install
  7. Run Jekyll with $ bundle exec jekyll serve --watch
  8. Begin hacking for your project

As a Jekyll 3.3 theme gem

  1. Download the starter /demo content, quick download link
  2. Install bundler with $ gem install bundler
  3. Install gems with $ bundle install
  4. Run Jekyll with $ bundle exec jekyll serve --watch
  5. Begin hacking for your project

Boilerplate & Theme differences

The boilerplate kit is better for more drastic hacking and changes, a project that's quite different to any other and needs a lot of custom work done. Additionally you'll only be able to use this method if you want to host it on GitHub Pages, as themes can't be submitted... yet.

Using the theme will allow you to receive updates made and will be more programmatic. To make your own changes you'll need to overwrite the files with your own. For example: If I want to change the colours of my site I'll need to copy the _colors.scss file and create my own in _sass/colors.scss with my own changes. This is the same for all files within the theme, which means your own project will be more lean than if you were to use the boilerplate.

Configuration

There's a number of settings you'll need to change before you can start hacking away at files. Here's a run down of what you'll need to change:

Gem dependency settings

twitter, author and social values will need to be changed to the projects' social information or removed. Look for the Gem settings comment within the /_config.yml file. These values are for the jekyll-seo-tag - follow the link to find out more.

Site settings

You'll need to change the description, title and url to match with the project. You'll also need to replace the /assets/placeholder-logo.svg /assets/placeholder-social.png with project logo and default social image. The email needs to be changed to the email you want to receive contact form enquires with. The disqus value should be changed to your project username on Disqus. Look for the Site settings comment within the /_config.yml file. The repo setting is optional, for now, and can be removed entirely, if you wish.

Site navigation

There are 3 different navigation types: one for the header, one for the footer and one for a set of social links shown in the aside (or sidebar). If the header or footer navigation are removed, they will fallback to a list of pages within the site. The social_navigation properties should either be one that is already in the list (so Twitter or Facebook) or simply link, This is so an icon can be set for the link. Look for the Site navigation comment within the /_config.yml file.

Using includes

There are 2 main types of includes: ones designed for the site and ones that are designed as shortcodes. Here are a list of the shortcode includes:

button.html

A button that can link to a page of any kind.

Example usage: {% include button.html text="I'm a button" link="https://daviddarnes.com" %}

Available options:

  • text: The text of the button required
  • link: The link that the button goes to required
  • icon: The icon that is added to the end of the button text
  • color: The color of the button

figure.html

An image with optional caption.

Example usage: {% include figure.html image="/uploads/feature-image.jpg" caption="Check out my photo" %}

Available options:

  • image: The image shown required
  • caption: A caption to explain the image
  • position: The position of the image. left, right or full

icon.html

An icon.

Example usage: {% include icon.html id="twitter" %}

Available options:

  • id: The reference for the icon required
  • title: The accessible label for the icon
  • color: The desired colour of the icon

nav-share.html

A set of buttons that share the current page to various social networks, which is controlled within the _config.yml file under the sharing_links keyword.

Example usage: {% include nav-share.html %}

Available options:

Twitter: "#1DA1F2"
facebook: "#3B5998"
Google+: "#DC4E41"
Pinterest: "#BD081C"
LinkedIn: "#0077B5"
tumblr: "#36465D"
Reddit: "#FF4500"
Hacker News: "#ff6600"
Designer News: "#2D72D9"
Email: ""

The first item is the name of the network (must be one of the ones stated above) and the second is the colour of the button. To remove a button just remove the line of the same name.

video.html

A YouTube video.

Example usage: {% include video.html id="zrkcGL5H3MU" %}

Available options:

  • id: The YouTube ID for the video required

map.html

A Google map. See Google My Maps

Example usage: {% include map.html id="1UT-2Z-Vg_MG_TrS5X2p8SthsJhc" %}

Available options:

  • id: The map ID for the video required

site-form.html

Adds a contact form to the page.

Example usage: {% include site-form.html %}

This include has no options. Use the email option in the /_config.yml to change to the desired email.

site-search.html

Adds a search form to the page.

Example usage: {% include site-search.html %}

This include has no options. This include will add a block of javascript to the page and javascript reference in order for the search field to work correctly.

Page layouts

As well as page, post, blog, there are a few alternative layouts that can be used on pages:

  • page-aside-left: Places the aside (sidebar) to the left of the content
  • home: Removes the aside entirely, leaving the full width for the main content (typically used for home page designs)
  • categories: Shows all posts grouped by category, with an index of categories in a left hand sidebar
  • search: Adds a search field to the page as well as a simplified version of the sidebar to allow more focus on the search results

Page and Post options

There are some more specific options you can apply when creating a page or a post:

  • comments: false: Turns off comments for that post
  • feature_image: "/uploads/feature-image.jpg": Adds a full width feature image at the top of the page
  • feature_text: "Example text": Adds text to the top of the page as a full width feature with solid colour; supports markdown. This can be used in conjunction with the feature_image option to create a feature image with text over it
  • indexing: false: Adds a noindex meta element to the <head> to stop crawler bots from indexing the page, used on the 404 page

Note: The Post List Page options are actually in the collection data within the _config.yml file.

Credits