Swedbank Pay Design Guide Theme for Jekyll

This repository hosts the Swedbank Pay Design Guide theme for Jekyll, used for Swedbank Pay on GitHub among other things.

Usage

To view this theme, browse to swedbankpay.github.io. If you'd like to host it locally on your computer, you need to do the following:

1. Clone this repository.
2. Jekyll is written in Ruby, so you'll need to download and install that.
3. To install the Ruby Gems this web site requires, you first need to install Bundler.
4. Once Ruby and Bundler is in place, type bundle install inside the root folder of this repository.
5. Run bundle exec jekyll serve to start the website.
6. Open http://localhost:4000 in a browser.

Jekyll should now be fired up with this theme. You can now add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, the site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When the 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 swedbankpay.gemspec accordingly.

Contributing

Bug reports and pull requests are welcome on GitHub. 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 as well as PayEx Open Source Development Guidelines.

License

This website is available as open source under the terms of the MIT License.