neon-bindings-jekyll-theme

A Jekyll theme for {www,guides}.neon-bindings.com.

Installation

Add this line to your Jekyll site's Gemfile:

gem "neon-bindings-jekyll-theme", :git => "https://github.com/neon-bindings/jekyll-theme"

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

theme: neon-bindings-jekyll-theme

And then execute:

$ bundle

Or install it yourself as:

$ gem install neon-bindings-jekyll-theme

Usage

TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.

Development

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

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.

License

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