-
Notifications
You must be signed in to change notification settings - Fork 407
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(README): update content for consistency
part of #815
- Loading branch information
1 parent
9abb8ac
commit 4edf0d4
Showing
10 changed files
with
61 additions
and
313 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,13 @@ | ||
# The Handlebars engine for Pattern Lab / Node | ||
# The Handlebars PatternEngine for Pattern Lab / Node | ||
|
||
To install the Handlebars engine in your edition, `npm install patternengine-node-handlebars` should do the trick. | ||
To install the Handlebars PatternEngine in your edition, `npm install @pattern-lab/engine-handlebars` should do the trick. | ||
|
||
## Supported features | ||
- [x] [Includes](http://patternlab.io/docs/pattern-including.html) | ||
- [x] Lineage | ||
- [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html) | ||
- [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html) | ||
- [x] [Pattern States](http://patternlab.io/docs/pattern-states.html) | ||
- [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html) (Accomplished instead using [native Handlebars partial arguments](http://handlebarsjs.com/partials.html)) | ||
- [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html) (Accomplished instead using [native Handlebars partial arguments](http://handlebarsjs.com/partials.html)) | ||
|
||
* [x] [Includes](http://patternlab.io/docs/pattern-including.html) | ||
* [x] Lineage | ||
* [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html) | ||
* [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html) | ||
* [x] [Pattern States](http://patternlab.io/docs/pattern-states.html) | ||
* [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html) (Accomplished instead using [native Handlebars partial arguments](http://handlebarsjs.com/partials.html)) | ||
* [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html) (Accomplished instead using [native Handlebars partial arguments](http://handlebarsjs.com/partials.html)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,22 @@ | ||
# The Liquid engine for Pattern Lab / Node | ||
# The Liquid PatternEngine for Pattern Lab / Node | ||
|
||
Based on the the stellar initial work found in https://github.com/cameronroe/patternengine-node-liquid | ||
|
||
## Installing | ||
|
||
To install the Underscore engine in your edition, `npm install pattern-lab/patternengine-node-underscore` should do the trick. | ||
|
||
To install the Liquid PatternEngine in your edition, `npm install @pattern-lab/engine-liquid` should do the trick. | ||
|
||
## Supported features | ||
|
||
This PatternEngine is in alpha and considered a work in progress. | ||
|
||
- [x] [Includes](http://patternlab.io/docs/pattern-including.html) | ||
- [x] Lineage | ||
* [x] [Includes](http://patternlab.io/docs/pattern-including.html) | ||
* [x] Lineage | ||
|
||
**TBD** | ||
|
||
- [ ] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html) | ||
- [ ] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html) | ||
- [ ] [Pattern States](http://patternlab.io/docs/pattern-states.html) | ||
- [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html) | ||
- [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html) | ||
* [ ] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html) | ||
* [ ] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html) | ||
* [ ] [Pattern States](http://patternlab.io/docs/pattern-states.html) | ||
* [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html) | ||
* [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
## The Mustache engine for Pattern Lab / Node | ||
## The Mustache PatternEngine for Pattern Lab / Node | ||
|
||
This one should be included by default with [Pattern Lab Node Core](https://github.com/pattern-lab/patternlab-node) and consumed by [Node Editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node). | ||
This one should be included by default with [Pattern Lab Node Core](https://github.com/pattern-lab/patternlab-node/packages/core) and consumed by [Node Editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node). | ||
|
||
If it's missing from your project for any reason, `npm install patternengine-node-mustache` should do the trick. | ||
If it's missing from your project for any reason, `npm install @pattern-lab/engine-mustache` should do the trick. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,14 @@ | ||
## The Twig engine for Pattern Lab / Node | ||
## The Twig PatternEngine for Pattern Lab / Node | ||
|
||
To install the Twig engine in your edition, `npm install patternengine-node-twig` should do the trick. | ||
To install the Twig engine in your edition, `npm install @pattern-lab/engine-twig` should do the trick. | ||
|
||
Level of Support is more or less full. Partial calls and lineage hunting are supported. Twig does not support the mustache-specific syntax extensions, style modifiers and pattern parameters, because their use cases are addressed by the core Twig feature set. | ||
## Supported features | ||
|
||
Level of support is more or less full. Partial calls and lineage hunting are supported. Twig does not support the mustache-specific syntax extensions, style modifiers and pattern parameters, because their use cases are addressed by the core Twig feature set. | ||
|
||
We are looking for help with the following issues: | ||
|
||
* [Pattern Lab does not support twig extends](https://github.com/pattern-lab/patternlab-node/issues/554) | ||
* [Verify maturity of Twig engine](https://github.com/pattern-lab/patternlab-node/issues/285) | ||
|
||
See https://github.com/pattern-lab/the-spec/issues/37 for more info. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.