jekyll-theme-svt

Follow the SVT Styleguide with Jekyll. This is a minimal theme for simple sites.

This theme is inspired by jekyll-theme-minimal

You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com

You can find the source code for Jekyll at GitHub: jekyll / jekyll

Installation

See instructions

Usage

TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.

Optionally define a menu in a menu.yml file in the _data directory.

menuItems:
- title: Why
  url: why
- title: What
  url: what
- title: How
  url: how

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

License

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

Primary Maintainer

Björn Molin https://github.com/orgs/SVT/people/bjornSVT