Code Monkey home page Code Monkey logo

jekyll-skeleton's Introduction

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.

Google Analytics

This theme has a google analytics helper for page views. All you have to do is add something like the following to your _config.yml:

google_analytics: "UA-00000000-1"
anonymize_ip: true

Use whatever your UA code is. The anonymize_ip option is to anonymize IP addresses when collecting tracking information. Anonymizing IP information means you don't track any sort of personal data.

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.

jekyll-skeleton's People

Contributors

awochna avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.