HTML Ruby CSS Makefile
Latest commit b1f2c5e Feb 4, 2017 @siddhantgoel bump version

README.md

clean-jekyll-theme

Gem Version

A Jekyll theme that tries to be as clean as possible, and uses Basscss underneath.

Screenshot

Screenshot

Installation

Add this line to your Jekyll site's Gemfile:

gem "clean-jekyll-theme"

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

theme: clean-jekyll-theme

And configure the navigation items in _data/navigation.yml

- title: about
  url: /about
- title: twitter
  url: https://twitter.com/johndoe
- title: github
  url: https://github.com/johndoe

And then execute:

$ bundle

Or install it yourself as:

$ gem install clean-jekyll-theme

Contributing

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

Development

To set up your environment to develop this theme, run bundle install.

You 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.

License

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