rlugojr / contrast

Lightweight Jekyll Theme

Contrast

Demo

Features

• mobile first
• syntax highlighting
• disqus / isso integration
• customizable
• valid HTML5

Please note: Create a master-branch if you want to use this theme with *.github.io.

Getting Started

If you're completely new to Jekyll, I recommend checking out the documentation at http://jekyllrb.com or there's a tutorial by Smashing Magazine.

Installing Jekyll

If you don't have Jekyll already installed, you will need to go ahead and do that.

$ gem install jekyll

Verify your Jekyll version

It's important to also check your version of Jekyll since this project uses Native Sass which is only supported by 2.0+.

$ jekyll -v
# This should be jekyll 2.0.0 or later

Fork, then clone

Fork the repo, and then clone it so you've got the code locally.

Modify the _config.yml

The _config.yml located in the root of the Pixyll directory contains all of the configuration details for the Jekyll site.

Jekyll Serve

Then, start the Jekyll Server. I always like to give the --watch option so it updates the generated HTML when I make changes.

$ jekyll serve --watch

Now you can navigate to localhost:4000 in your browser to see the site.

Using Github Pages

You can host your Jekyll site for free with Github Pages. Click here for more information.

License

This project is licensed under the terms of the MIT license.

Thanks to the following:

• Jekyll
• Github Pages
• Richard Leland: pygment
• mrdoob: three.js
• Font Awesome
• Paul D. Hunt: Source Sans Pro
• Victor Gaultney: Gentium Basic
• John Otander: Pixyll