Important

This project is no longer actively maintained.

The source code in this repository is no longer maintained. It has been superseded by version 2, which offers improved features and better support.

Thank you to all who have contributed to this project. We recommend transitioning to Os2Display version 2 for continued support and updates.

Final Release: The final stable release is version v4.2.2

!!! Deprecation warning !!!

This repository has been included in the admin-bundle in os2display 5.0.0.

No new development should be made in this repository. It only exists for backwards compatibility regarding vagrants.

OS2Display Styleguide

OS2Display styleguide using Pattern Lab.

Install Pattern Lab

Prerequisites: git and Composer installed.

In the styleguidedirectory run:

composer create-project pattern-lab/edition-twig-standard pattern-lab

When prompted for suggested starterkit choose:

1: pattern-lab/starterkit-twig-base

In the file pattern-lab/config/config.yml change sourceDir to:

sourceDir: ../source

and change publicDir to:

sourceDir: ../public

If everything went well you should now be able to generate the static Pattern Lab site. In the pattern-lab directory run:

php core/console --generate

Start the server

To start the server, in the pattern-lab directory run:

php core/console --server

Watch for Changes and Reload

Pattern Lab can watch for changes to files in the source folder and automatically rebuild the entire Pattern Lab website for you. Make your changes, save the file, and Pattern Lab takes care of the rest.

Install the Auto-Reload Plugin:

composer require pattern-lab/plugin-reload

Run the server with watch and auto reload:

php core/console --server --with-watch