@pattern-lab/edition-node
v6.1.0
Published
A pure wrapper around patternlab-node core, the default pattern engine, and supporting frontend assets.
Downloads
770
Readme
Pattern Lab - Node Edition
The pure wrapper around Pattern Lab Node Core, the default pattern engine, and supporting frontend assets.
Online Demo of Pattern Lab Output
Packaged Components
This Edition comes with the following components:
@pattern-lab/core
: GitHub | npm@pattern-lab/cli
: GitHub | npm@pattern-lab/engine-handlebars
: GitHub | npm@pattern-lab/uikit-workshop
: GitHub | npm
Prerequisites
This Edition uses Node for core processing and npm to manage project dependencies. You can follow the directions for installing Node on the Node website if you haven't done so already. Installation of Node will include npm.
Installing
The Pattern Lab Node can be used in different ways. Editions like this one are example pairings of Pattern Lab code and do not always have an upgrade path or simple means to run as a dependency within a larger project. Users wishing to be most current and have the greatest flexibility are encouraged to consume core
directly. Users wanting to learn more about Pattern Lab and have a tailored default experience are encouraged to start with an edition. Both methods still expect to interact with other elements of the Pattern Lab Ecosystem.
Read the installation instructions.
Getting Started
This edition comes pre-packaged with a couple simple scripts. Extend them as needed.
build patterns, copy assets, and construct ui
npm run build
build patterns, copy assets, and construct ui, watch source files, and serve locally
npm run serve
logs Pattern Lab Node usage and help content
npm run help
To interact further with Pattern Lab Node, such as to install plugins or starterkits, it's suggested to incorporate the Pattern Lab Node Command Line Interface or learn more about the core API.
Updating Pattern Lab
To update Pattern Lab please refer to each component's GitHub repository, and the master instructions for core. The components are listed at the top of the README.