Pattern Lab Standard Edition for Mustache

The Pattern Lab Standard Edition for Mustache is the evolution of Pattern Lab 1. Pattern Lab is still, at its core, a prototyping tool focused on encouraging communication between content creators, designers, devs, and clients. It combines platform-agnostic assets, like the Mustache-based patterns, with a PHP-based "builder". Pattern Lab 2 introduces the beginnings of an ecosystem that will allow teams to mix, match and extend Pattern Lab to meet their specific needs. It will also make it easier for the Pattern Lab team to push out new features. Pattern Lab Standard Edition for Mustache is just one of four PHP-based Editions currently available.

Demo

You can play with a demo of the front-end of Pattern Lab at demo.patternlab.io.

Getting Started

• Requirements
• Installing
• Generating
• Viewing
• Editing
• Using commands
• Upgrading
• More documentation

Installing

There are two methods for downloading and installing the Standard Edition for Mustache:

• Download a pre-built project
• Create a project based on this Edition with Composer

Download a pre-built project

The fastest way to get started with Pattern Lab's Standard Edition for Mustache is to download the latest pre-built version from the releases page.

Note: You'll need to install Composer in the future if you want to upgrade Pattern Lab.

Use Composer to create a project

Pattern Lab uses Composer to manage project dependencies.

1. Install Composer

Please follow the directions for installing Composer on the Composer website. We recommend you install it globally.

2. Install the Standard Edition for Mustache

Use Composer's create-project command to install the Standard Edition for Mustache into a location of your choosing. To create a project do the following:

1. In a terminal window navigate to the root of your project
2. Type composer create-project pattern-lab/edition-mustache-webdesignday your-project-name && cd $_

This will install the Standard Edition for Mustache into a directory called your-project-name in install/location/. You will be automatically dropped into the project directory after the process is finished.

Migrating from Pattern Lab 1 to Pattern Lab 2

Pattern Lab 2 was a complete rewrite and reorganization of Pattern Lab 1. After installing the Standard Edition for Mustache do the following to migrate from Pattern Lab 1 to Pattern Lab 2:

1. Copy ./source from your old project to your new install
2. Copy ./source/_patterns/00-atoms/00-meta/_00-head.mustache to ./source/_meta/_00-head.mustache
3. Copy ./source/_patterns/00-atoms/00-meta/_01-foot.mustache to ./source/_meta/_00-foot.mustache
4. Copy ./source/_data/annotations.js to ./source/_annotations/annotations.js

Everything else should work without changes.

Need Pattern Lab 1?

The source code for Pattern Lab 1 is still available for download.

Packaged Components

The Standard Edition for Mustache installs the following components:

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

List the Available Commands and Their Options

To list all available commands type:

php core/console --help

To list the options for a particular command type:

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