pattern-lab/edition-twig-standard

Standard Edition of Pattern Lab for Twig. Installs all Twig-related assets except for a StarterKit.

, _(*1)

Pattern Lab Standard Edition for Twig

The Standard Edition for Twig gives developers and designers a clean and stable base from which to develop a Twig-based pattern library., _(*2)

Packaged Components

The Standard Edition for Twig comes with the following components:, _(*3)

• pattern-lab/core: GitHub, Packagist
• pattern-lab/patternengine-twig: documentation, GitHub, Packagist
• pattern-lab/styleguidekit-assets-default: GitHub, Packagist
• pattern-lab/styleguidekit-twig-default: GitHub, Packagist

Installing

There are two methods for downloading and installing the Standard Edition for Twig:, _(*4)

• Download a pre-built project
• Use Composer to create a project

Download a pre-built project

The fastest way to get started with the Standard Edition for Twig is to download the pre-built version from the releases page. The pre-built project comes with the Base StarterKit for Twig installed by default., _(*5)

Please note: Pattern Lab uses Composer to manage project dependencies. To upgrade the Standard Edition for Twig or to install plug-ins you'll need to install Composer. We recommend that you install it globally., _(*6)

Use Composer to create a project

Pattern Lab uses Composer to manage project dependencies., _(*7)

1. Install Composer

Please follow the directions for installing Composer on the Composer website. We recommend you install it globally., _(*8)

2. Install the Standard Edition for Twig

Use Composer's create-project command to install the Standard Edition for Twig into a location of your choosing. In Terminal type:, _(*9)

cd install/location/
composer create-project pattern-lab/edition-twig-standard your-project-name && cd $_

This will install the Standard Edition for Twig into a directory called your-project-name in install/location/. During the set-up process you will be asked to install an appropriate StarterKit. You will be automatically dropped into the project directory after the process is finished., _(*10)

Updating Pattern Lab

To update Pattern Lab please refer to each component's GitHub repository. The components are listed at the top of the README., _(*11)

Helpful Commands

These are some helpful commands you can use on the command line for working with Pattern Lab., _(*12)

List all of the available commands

To list all available commands type:, _(*13)

php core/console --help

To list the options for a particular command type:, _(*14)

php core/console --help --[command]

Generate Pattern Lab

To generate the front-end for Pattern Lab type:, _(*15)

php core/console --generate

Watch for changes and re-generate Pattern Lab

To watch for changes and re-generate the front-end for Pattern Lab type:, _(*16)

php core/console --watch

Start a server to view Pattern Lab

You can use PHP's built-in web server to review your Pattern Lab project in a browser. In a seperate window type:, _(*17)

php core/console --server

Then open http://localhost:8080 in your browser., _(*18)

Install a StarterKit

To install a near-empty StarterKit as a starting point for your project type:, _(*19)

php core/console --starterkit --init

To install a specific StarterKit from GitHub type:, _(*20)

php core/console --starterkit --install <starterkit-vendor/starterkit-name>