The project is in a healthy, maintained state
Swedbank Pay Design Guide theme for Jekyll
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Dependencies

Development

Runtime

>= 3.7, < 5.0
~> 1.11
>= 1.0.1, < 3
~> 0.12
~> 3, >= 3.7
~> 1, >= 1.3.2
 Project Readme

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.

Docker

  1. Install Docker, using Linux containers. Make sure virtualization is enabled on your machine.
  2. Open a console window at the root of the repository and run docker-compose up

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. Once Ruby ,Bundler, and Graphviz, is in place, type bundle install inside the root folder of this repository.
  6. Run bundle exec jekyll serve to start the website.
  7. Open http://localhost:4000 in a browser.

Required Visual Studio Code plugins

  • shd101wyy.markdown-preview-enhanced, to render Markdown to HTML in a preview window.
  • bpruitt-goddard.mermaid-markdown-syntax-highlighting, to give syntax highlighting to Mermaid diagrams in Markdown files.
  • yzhang.markdown-all-in-one, to enable a plethora of Markdown features, most importantly formatting of Markdown tables with VS Code's built-in format functionality.
  • stkb.rewrap, to make line-breaking text at 80 characters easier.
  • supperchong.pretty-json to format selected JSON snippets in code examples.
  • sissel.shopify-liquid for syntax highlighting of Liquid.
  • Set up a ruler at 80 characters by adding "editor.rulers": [80] to its configuration.

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 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.