nvdnkpr / patternlab-node Goto Github PK

The Node version of Pattern Lab is, at its core, a static site generator. It combines platform-agnostic assets, like the Mustache-based patterns and the JavaScript-based viewer, with a Node-based "builder" that transforms and dynamically builds the Pattern Lab site. By making it a static site generator, the Node version of Pattern Lab strongly separates patterns, data, and presentation from build logic. The Node version is a work in progress, the PHP version should be seen as a reference for other developers to improve upon as they build their own Pattern Lab Builders in their language of choice.

To run patternlab-node, just do the following from the command line at the root of patternlab-node:

1. npm install
2. npm install -g grunt-cli
3. grunt

This creates all patterns, the styleguide, and the pattern lab site. patternlab.json is a file created for debugging purposes. It tells you all the secrets in tidy json.

To have patternlab-node watch for changes to either a mustache template, data, or stylesheets, run grunt watch. The Gruntfile governs what is watched. It should be easy to add scss or whatever preprocessor you fancy.

The Node version of Pattern Lab is under active development by @bmuenzenmeyer and contributors. Pull requests welcome, but please take a moment to read the guidelines.

Dave Olsen has published the specification for Pattern Lab ports. Development will be oriented toward compliance with this as the spec and the port mature together.

A lot of good conversation has revolved around whether Pattern Lab is a platform or a tool in the toolbox, part of a larger solution. It's my goal to #1) adhere to the specification and #2) meet the needs of both use cases.

THE FOLLOWING IS FROM THE PATTERNLAB-PHP PROJECT. A LOT STILL APPLIES TO PATTERNLAB-NODE, BUT IT HAS NOT BEEN ADAPTED YET. USE AT YOUR OWN PERIL

===

You can play with a demo of the front-end of the PHP version of Pattern Lab at demo.pattern-lab.info.

The PHP version of Pattern Lab should be relatively easy for anyone to get up and running.

• Requirements
• Installing the PHP Version of Pattern Lab
• Generating the Pattern Lab Website for the First Time
• Editing the Pattern Lab Website Source Files
• Using the Command-line Options

Patterns are the core element of Pattern Lab. Understanding how they work is the key to getting the most out of the system. Patterns use Mustache so please read Mustache's docs as well.

• How Patterns Are Organized
• Adding New Patterns
• Reorganizing Patterns
• Converting Old Patterns
• "Hiding" Patterns in the Navigation
• Including One Pattern Within Another via Partials
• Linking Directly to a Pattern
• Managing Assets for a Pattern: JavaScript, images, CSS, etc.
• Modifying the Standard Header & Footer for Patterns

The PHP version of Pattern Lab utilizes Mustache as the template language for patterns. In addition to allowing for the inclusion of one pattern within another it also gives pattern developers the ability to include variables. This means that attributes like image sources can be centralized in one file for easy modification across one or more patterns. The PHP version of Pattern Lab uses a JSON file, source/_data/data.json, to centralize many of these attributes.

• Introduction to JSON & Mustache Variables
• Overriding the Central data.json Values with Pattern-specific Values
• Linking to Patterns with Pattern Lab's Default link Variable
• Creating Lists with Pattern Lab's Default listItems Variable

By default, the Pattern Lab assets can be manually generated and the Pattern Lab site manually refreshed but who wants to waste time doing that? Here are some ways that the PHP version of Pattern Lab can make your development workflow a little smoother:

• Watching for Changes and Auto-Regenerating Patterns
• Auto-Reloading the Browser Window When Changes Are Made
• Multi-browser & Multi-device Testing with Page Follow