https://github.com/esporo/steve

A charming and fun blog theme for Jekyll.
https://github.com/esporo/steve

jekyll jekyll-theme two-columns

Last synced: 3 months ago
JSON representation

A charming and fun blog theme for Jekyll.

• Host: GitHub
• URL: https://github.com/esporo/steve
• Owner: esporo
• License: mit
• Created: 2021-04-18T19:36:21.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-06T05:05:51.000Z (5 months ago)
• Last Synced: 2024-10-01T15:49:56.274Z (3 months ago)
• Topics: jekyll, jekyll-theme, two-columns
• Language: SCSS
• Homepage: https://esporo.github.io/steve/
• Size: 115 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Steve for Jekyll

Steve is a charming and fun blog theme for [Jekyll](https://jekyllrb.com/), the static site generator. It's developed by [@arthrfrts](https://github.com/arthrfrts) to be used on the [Esporo](https://esporo.net/) websites — but feel free to use it in any project you may find it fitting.

See it in action on the [demo site](https://esporo.github.io/steve).

## Installation

Add this line to your Jekyll site's `Gemfile`:

```ruby

gem "steve-for-jekyll"

```

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

```yaml

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](https://github.com/esporo/steve/wiki) to learn how to add menus, comments, change your theme style or set up Steve's options.

## Contributing

Bug reports and pull requests are welcome on GitHub at . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## Development

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.

## License

The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).