You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-34Lines changed: 38 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,6 +73,40 @@ Pattern states should be lowercase and use hyphens where spaces are present.
73
73
}
74
74
```
75
75
76
+
##### Pattern Export
77
+
`config.json` also has two properties that work together to export completed patterns for use in a production environment. Provide an array of keys and an output directory. Pattern Lab doesn't ship with any pattern export keys, but the default directory is `"./pattern_exports/"` created inside the install directory.
Coupled with exported css (much easier to extract with existing tools like [grunt-contrib-copy](https://github.com/gruntjs/grunt-contrib-copy)), pattern export can help to maintain the relevancy of the design system by directly placing partials in a directory of your choosing.
85
+
86
+
##### baseurl
87
+
88
+
If your instance of Pattern Lab lives in a subdirectory of your server, for instance on github pages (ex: yourusername.github.io/patterns-demo/), then add the baseurl here. The baseurl is everything after the hostname - ie: `patterns-demo`
89
+
90
+
```
91
+
"baseurl" : "/patterns-demo"
92
+
```
93
+
94
+
Default: blank
95
+
96
+
##### excluding patterns
97
+
98
+
If you'd like to exclude an individual pattern you can do so by prepending the filename with an underscore, like: `_filename.mustache`
99
+
100
+
You can also exclude complete directories by prepending the directory name with an underscore, like: `/_experiment/...`
101
+
102
+
##### Verbose Mode
103
+
`patternlab.json` is a file created for debugging purposes. Set `debug` to true in `.config.json` to see all the secrets.
104
+
105
+
##### Server
106
+
Running `grunt serve` will compile the patternlab front end and host it on <ahref="http://localhost:9001">http://localhost:9001</a> by default. Page will reload on any saved source code change.
107
+
108
+
### Advanced Pattern Library Features
109
+
76
110
##### Pattern Parameters
77
111
Pattern parameters are a simple mechanism for replacing Mustache variables via attributes on a pattern partial tag rather than having to use a pattern-specific json file. They are especially useful when you want to supply distinct values for Mustache variables in a specific pattern partial instance that may be included multiple times in a molecule, template, or page.
78
112
@@ -157,38 +191,6 @@ This would compile to:
157
191
As you can see, it's a much easier way of linking patterns to one another.
158
192
159
193
160
-
##### Pattern Export
161
-
`config.json` also has two properties that work together to export completed patterns for use in a production environment. Provide an array of keys and an output directory. Pattern Lab doesn't ship with any pattern export keys, but the default directory is `"./pattern_exports/"` created inside the install directory.
Coupled with exported css (much easier to extract with existing tools like [grunt-contrib-copy](https://github.com/gruntjs/grunt-contrib-copy)), pattern export can help to maintain the relevancy of the design system by directly placing partials in a directory of your choosing.
169
-
170
-
##### baseurl
171
-
172
-
If your instance of Pattern Lab lives in a subdirectory of your server, for instance on github pages (ex: yourusername.github.io/patterns-demo/), then add the baseurl here. The baseurl is everything after the hostname - ie: `patterns-demo`
173
-
174
-
```
175
-
"baseurl" : "/patterns-demo"
176
-
```
177
-
178
-
Default: blank
179
-
180
-
##### excluding patterns
181
-
182
-
If you'd like to exclude an individual pattern you can do so by prepending the filename with an underscore, like: `_filename.mustache`
183
-
184
-
You can also exclude complete directories by prepending the directory name with an underscore, like: `/_experiment/...`
185
-
186
-
##### Verbose Mode
187
-
`patternlab.json` is a file created for debugging purposes. Set `debug` to true in `.config.json` to see all the secrets.
188
-
189
-
##### Server
190
-
Running `grunt serve` will compile the patternlab front end and host it on <ahref="http://localhost:9001">http://localhost:9001</a> by default. Page will reload on any saved source code change.
191
-
192
194
===
193
195
194
196
The Node version of Pattern Lab is maintained by [@bmuenzenmeyer](https://twitter.com/bmuenzenmeyer) and contributors. Pull requests welcome, but please take a moment to read the [guidelines](https://github.com/pattern-lab/patternlab-node/blob/master/CONTRIBUTING.md).
@@ -197,9 +199,11 @@ The Node version of Pattern Lab is maintained by [@bmuenzenmeyer](https://twitte
197
199
198
200
You can find some simple upgrade documenation in it's current home here (unreleased but confirmed to work): [https://github.com/pattern-lab/website/blob/dev/patternlabsite/docs/node/upgrading.md](https://github.com/pattern-lab/website/blob/dev/patternlabsite/docs/node/upgrading.md)
199
201
200
-
### Forward, To the Specification!
202
+
### ROADMAP
203
+
204
+
A roadmap exists for Pattern Lab Node. Check it out [here](https://github.com/pattern-lab/patternlab-node/issues/134)
201
205
202
-
Dave Olsen has published the [specification](https://github.com/pattern-lab/the-spec/blob/draft/SPEC.md) for Pattern Lab ports. Development will be oriented toward compliance with this as the spec and the port mature together.
206
+
Dave Olsen has also published the [specification](https://github.com/pattern-lab/the-spec/blob/draft/SPEC.md) for Pattern Lab ports. Development will be oriented toward compliance with this as the spec and the port mature together.
0 commit comments