Skip to content

Commit d10a13c

Browse files
dnwhtebmuenzenmeyer
authored andcommitted
Update readme
1 parent 8316422 commit d10a13c

File tree

1 file changed

+16
-3
lines changed
  • packages/patternengine-node-nunjucks

1 file changed

+16
-3
lines changed

packages/patternengine-node-nunjucks/README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
# STILL IN DEVELOPMENT (NOT AVAILABLE YET)
1+
# A Nunjucks engine for Pattern Lab / Node
22

3-
## The Nunjucks engine for Pattern Lab / Node
3+
## Installing
44

5-
To install the Nunjucks engine in your edition, `npm install patternengine-node-nunjucks` should do the trick.
5+
To install the Nunjucks engine in your edition, run `npm install patternengine-node-nunjucks`.
6+
7+
## Supported features
8+
- [x] [Includes](http://patternlab.io/docs/pattern-including.html)
9+
- [x] Lineage
10+
- [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
11+
- [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
12+
- [x] [Pattern States](http://patternlab.io/docs/pattern-states.html)
13+
- [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html) (Accomplished instead using native Nunjucks variables)
14+
- [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html) (Accomplished instead using native Nunjucks variables)
615

716
Level of Support is more or less full. Partial calls and lineage hunting are supported. Nunjucks does not support the mustache-specific syntax extensions, style modifiers and pattern parameters, because their use cases are addressed by the core Nunjucks feature set. Pattern Lab's listitems feature is still written in the mustache syntax.
817

@@ -35,3 +44,7 @@ exports = module.exports = function (nunjucks, env) {
3544
});
3645
};
3746
```
47+
48+
## What Nunjucks features are missing?
49+
50+
I have not yet figured out a way to support variables in pattern includes. I'm thinking it might be possible to use Nunjucks precompile feature to get the compiled partial name before returning it to Pattern Lab, but just a thought at this point.

0 commit comments

Comments
 (0)