hoffnung3000-theme

Jekyll theme for archiving HOFFNUNG3000 festivals.

Installation

Add this line to your Jekyll site's Gemfile:

gem "hoffnung3000-theme"

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

theme: hoffnung3000-theme

And then execute:

$ bundle

Or install it yourself as:

$ gem install hoffnung3000-theme

Usage

Edit your _config.yml to contain the following keys, with your own values:

hoffnung3000:
    url: "https://your-hoffnung3000-instance.org"
    title: "Your Festival Name"

Then run this command to fetch event data from your festival site:

$ bundle exec jekyll hoffnung3000 events

Now your site will be ready to serve by running:

$ bundle exec jekyll serve

Contributing

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.

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 hoffnung3000-theme.gemspec accordingly.

License