Add this line to your Jekyll site's Gemfile
:
gem "plaincheck"
And add this line to your Jekyll site's _config.yml
:
theme: plaincheck
And then execute:
bundle
Or install it yourself as:
gem install plaincheck
TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
Bug reports and pull requests are welcome on GitHub at https://github.com/JoelEllis/Plaincheck.
This project is intended to be a safe, welcoming space for collaboration, so contributors are expected to adhere to the Contributor Covenant code of conduct.
To set up your environment to develop Plaincheck, run bundle install
. It's now ready for any edits and testing you want!
To test it, run bundle exec jekyll serve
and open your browser at http://localhost:4000
. This starts a local server.
Remember: When the theme is released, only the files in _layouts
, _includes
, _sass
and assets
tracked with Git will be bundled.
To add a custom directory to the gem, please edit the regexp in plaincheck.gemspec
accordingly.
The theme is available as open source under the terms of the MIT License.