Swedbank Pay Design Guide Theme for Jekyll

Swedbank Pay Design Guide Theme for Jekyll

Test status Deploy status License Codacy CLA assistant Contributor Covenant

This repository hosts the Swedbank Pay Design Guide theme for Jekyll, used for Swedbank Pay Developer Portal 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 have two options, manual install or Docker. The Docker installation is the one we recommend to use for its simplicity.

After either a Docker or manual installation Jekyll should 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.

  1. Clone this repository.
  2. Install Docker Personal. Select default settings when prompted.
  3. Open a console window at the root of the repository and run docker-compose up. This will create a docker container and spin it up with everything that's specified in the repository gemfile.
  4. Open http://localhost:4000 in a browser.

Manual install

  1. Clone this repository.
  2. Jekyll is written in Ruby, so you'll need to download and install that. If you're installing on Windows, choose setup with DevKit.
  3. To install the Ruby Gems this web site requires, you first need to install Bundler.
  4. Install Graphviz, this will require Java.
  5. Run Visual Studio Code (VSC) and open the repository.
  6. Verify that Git is installed by running git status in VSC terminal. If Git is not properly installed, you will see an error message like the one below. Just download Git and install. Alt text
  7. Once Ruby ,Bundler, and Graphviz, is in place, type bundle install inside the root folder of this repository.
  8. Run bundle exec jekyll serve to start the website.
  9. Open in a browser.

Visual Studio Code plugins

You might want to install plugins for Markdown, Mermaid, JSON and Liquid as this will enhance your coding experience.

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 code of conduct and sign the contributor's license agreement.

License

The code within this repository is available as open source under the terms of the Apache 2.0 License and the contributor's license agreement.