/paradigm-shift-jekyll-theme

Jekyll Port of Paradigm Shift

Primary LanguageSCSSMIT LicenseMIT

paradigm-shift-jekyll-theme

LICENSE

Preview: Live Demo

Screenshot

About

This is the Paradigm Shift template, converted to a gem-based Jekyll theme with GitHub Pages support.

Installation

Add this line to your Jekyll site's Gemfile:

gem "paradigm-shift-jekyll-theme"

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

theme: paradigm-shift-jekyll-theme

And then execute:

$ bundle

Or install it yourself as:

$ gem install paradigm-shift-jekyll-theme

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/avicndugu/paradigm-shift-jekyll-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors. If you have an idea, suggestion, feature request, etc., feel free to open an issue or pull request.

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 paradigm-shift-jekyll-theme.gemspec accordingly.

License

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