Shine on You Crazy Diamond Theme

Jekyll theme for my website.

Installation

Add this line to your Jekyll site's Gemfile:

gem "shine-on-you-crazy-diamond-theme"

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

theme: shine-on-you-crazy-diamond-theme

And then execute:

$ bundle

Or install it yourself as:

$ gem install shine-on-you-crazy-diamond-theme

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, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in shine-on-you-crazy-diamond-theme.gemspec accordingly.

Publishing

Build theme:

$ gem build shine-on-you-crazy-diamond-theme.gemspec

Push theme up to the RubyGems:

$ gem push shine-on-you-crazy-diamond-theme-x.x.x.gem

License

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