Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/swedbankpay/swedbank-pay-design-guide-jekyll-theme

Swedbank Pay Design Guide theme for Jekyll
https://github.com/swedbankpay/swedbank-pay-design-guide-jekyll-theme

design-guide jekyll ruby swedbank-pay

Last synced: about 2 months ago
JSON representation

Swedbank Pay Design Guide theme for Jekyll

Awesome Lists containing this project

README 

        
# Swedbank Pay Design Guide Theme for Jekyll



![Swedbank Pay Design Guide Theme for Jekyll][opengraph-image]



![Test status][test-badge]

![Deploy status][deploy-badge]

[![License][license-badge]][license]

[![Codacy][codacy-badge]][codacy]

[![CLA assistant][cla-badge]][cla]

[![Contributor Covenant][coc-badge]][coc]



This repository hosts the [Swedbank Pay Design Guide][design-guide] theme for

Jekyll, used for [Swedbank Pay Developer Portal][developer-portal] among other

things.



## Usage



To view this theme, browse to [swedbankpay.github.io][swedbankpay]. If you'd

like to host it locally on your computer, you have two options, manual install

or [Docker][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.

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.



### Docker (recommended)



1.  [Clone this repository][clone].

2.  [Install Docker Personal][docker]. 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][clone].

2.  Close Visual Studio Code (VSC) if you have it running

3.  Jekyll is written in [Ruby][ruby], so you'll need to download and install

    that.

    Note: If you're installing on Windows, choose Ruby+Devkit Installers.

4.  Open VSC and open the repository

5.  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][git] and install.

    ![Alt text](image.png)

6.  Type `bundle install` inside the root folder of this repository.

7.  Run `bundle exec jekyll serve` to start the website.

8.  Open in a browser.



### Visual Studio Code plugins



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



## Contributing



Bug reports and pull requests are welcome on [GitHub][github]. This project is

intended to be a safe, welcoming space for collaboration, and contributors are

expected to adhere to the [code of conduct][coc] and sign the

[contributor's license agreement][cla].



## License



The code within this repository is available as open source under the terms of

the [Apache 2.0 License][license] and the [contributor's license

agreement][cla].



[cla-badge]:            

[cla]:                  

[clone]:                

[coc-badge]:            

[coc]:                  <./CODE_OF_CONDUCT.md>

[codacy-badge]:         

[codacy]:               

[deploy-badge]:         

[design-guide]:         

[developer-portal]:     

[docker]:               

[git]:                  

[github]:               

[license-badge]:        https://img.shields.io/github/license/SwedbankPay/swedbank-pay-design-guide-jekyll-theme

[license]:              

[opengraph-image]:      

[ruby]:                 

[swedbankpay]:          

[test-badge]: