jekyll-skeleton

A basic Jekyll theme based on Minima and Skeleton CSS


Keywords
jekyll, jekyll-theme, skeleton, skeleton-css
License
MIT
Install
gem install jekyll-skeleton -v 1.4.0

Documentation

jekyll-skeleton

Gem Version

Super simple implementation of Skeleton CSS as a Jekyll theme.

Why?

I got tired of heavy CSS frameworks (Bootstrap & Foundation) being large downloads and getting in my way of customizing my blog. I know you can select only the components you want from each of these and throw away others, but that seemed like the opposite direction than I wanted to work from.

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-skeleton"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-skeleton

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-skeleton

This will give you some simple, basic layouts (nothing fancy) and the basic CSS. It's just a skeleton, after all ;)

You can add custom CSS in assets/style.css in your Jekyll site and it'll automatically be included.

Adding Related Posts

To list related posts at the end of a post, add the following line to your _config.yaml:

include_related_posts: true

Then, the top 5 related posts will be listed. See Jekyll's docs for more information on what this means.

Enabling comments via Disqus

If you have a Disqus account, you can enable comments for your posts in the same way as you do for Minima, by adding the following to your _config.yml:

disqus:
  shortname: my_disqus_shortname

Like in Minima, comments are enabled by default and appear only in a production environment (JEKYLL_ENV=production).

Adding comments: false to a post's YAML front matter turns off displaying comments for that post.

Privacy Policy link

You can provide a link to your privacy policy in the footer of your site by specifying the URL in your _config.yml file. Add the following:

privacy_policy_url: "/your-privacy-policy-url-here"

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/awochna/jekyll-skeleton. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

To set up your environment to develop this theme, run bundle install.

There is an example site in the example/ folder using this theme that you can develop against.

License

The theme is available as open source under the terms of the MIT License.