Steve is a charming and fun blog theme for Jekyll, the static site generator. It's developed by @arthrfrts to be used on the Esporo websites — but feel free to use it in any project you may find it fitting.
See it in action on the demo site.
Add this line to your Jekyll site's Gemfile
:
gem "steve-for-jekyll"
And add this line to your Jekyll site's _config.yml
:
theme: steve-for-jekyll
And then execute:
$ bundle
Or install it yourself as:
$ gem install steve
Steve will work out-of-the-box when installed, but it has plenty of options for you to make it yours. Refer to the theme documentation to learn how to add menus, comments, change your theme style or set up Steve's options.
Bug reports and pull requests are welcome on GitHub at https://github.com/esporo/steve. 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 steve-for-jekyll.gemspec
accordingly.
The theme is available as open source under the terms of the MIT License.