/jekyll-theme-jam

Primary LanguageSCSSMIT LicenseMIT

jekyll-theme-jam

Gem Version MIT licensed

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-jam"

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

theme: jekyll-theme-jam

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-jam

This theme can also be used with jekyll-remote-theme. To do so:

  1. Add the gem to your Gemfile under Jekyll-Plugins
# If you have any plugins, put them here!
group :jekyll_plugins do
    # other plugins...
    gem "jekyll-remote-theme"
    # other plugins...
end
  1. Specify the repository in the 'remote_theme' tag in _config.yml remote_theme: desiredpersona/jekyll-theme-jam

N.B: When using remote-theme and doing style overrides things are a little different. First, make a file assets/css/jam.scss (filepath from Jekyll root)

Inside the jam.scss file, put the following boilerplate code at the top of the file before defining any style rules

---
---
@import "_theme";

Usage

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

Credits

Creator

Desired Persona

Thanks

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/desiredpersona/jekyll-theme-jam. 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.

License

MIT