This Jekyll theme is a base, a buttery biscuit base. The goal is to have a theme that is easy to customise whilst using as a Gem based theme, resulting is a basic frame work for any Jekyll project. Made using chota as a css framework and Gutenberg for print styling
Add this line to your Jekyll site's Gemfile:
gem "jekyll-theme-buttery-biscuit"And add this line to your Jekyll site's _config.yml:
theme: jekyll-theme-buttery-biscuitAnd then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-theme-buttery-biscuit
Buttery Biscuit uses its own collection of settings in the _config.yml as follows:
buttery-biscuit:
theme: default
darkmode: false
fixed-navbar: falseThe theme and darkmode settings reference sass files from the _sass/themes folder and overwrite the default html variables of chota as well as introduce additional css changes.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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.
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 jekyll-theme-buttery-biscuit.gemspec accordingly.
The theme is available as open source under the terms of the MIT License.