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
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,7 @@ Get more information about patternlab-node, pattern lab in general, and where to
86
86
To have patternlab-node watch for changes to either a mustache template, data, or stylesheets, run `grunt|gulp watch` or `grunt|gulp serve`. The `Gruntfile|Gulpfile` governs what is watched. It should be easy to add scss or whatever preprocessor you fancy.
87
87
88
88
##### Configurable Paths
89
-
Pattern Lab Node ships with a particular source and public workflow intended to separate the code you work on with the code generated for consumption elsewhere. If you wish to change any paths, you may do so within `config.json`. The contents are here:
89
+
Pattern Lab Node ships with a particular source and public workflow intended to separate the code you work on with the code generated for consumption elsewhere. If you wish to change any paths, you may do so within `patternlab-config.json`. The contents are here:
90
90
91
91
```
92
92
"paths" : {
@@ -117,7 +117,7 @@ Pattern Lab Node ships with a particular source and public workflow intended to
117
117
Note the intentional repitition of the nested structure, made this way for maximum flexibility. Relative paths are default but absolute paths should work too. You may also use these paths within Grunt or Gulp files by referring to the paths() object.
118
118
119
119
##### Nav Bar Controls
120
-
If you don't have a need for some of the nav-bar tools in the Pattern Lab frontend, you can turn them off in `config.json`.
120
+
If you don't have a need for some of the nav-bar tools in the Pattern Lab frontend, you can turn them off in `patternlab-config.json`.
121
121
122
122
The current selection is as follows.
123
123
@@ -144,7 +144,7 @@ The current selection is as follows.
144
144
}
145
145
```
146
146
##### Pattern States
147
-
You can set the state of a pattern by including it in `config.json` too. The out of the box styles are in progress (orange), in review (yellow), and complete (green).
147
+
You can set the state of a pattern by including it in `patternlab-config.json` too. The out of the box styles are in progress (orange), in review (yellow), and complete (green).
148
148
Pattern states should be lowercase and use hyphens where spaces are present.
149
149
```
150
150
"patternStates": {
@@ -155,7 +155,7 @@ Pattern states should be lowercase and use hyphens where spaces are present.
155
155
```
156
156
157
157
##### Pattern Export
158
-
`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.
158
+
`patternlab-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.
@@ -165,7 +165,7 @@ Pattern states should be lowercase and use hyphens where spaces are present.
165
165
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.
166
166
167
167
##### cacheBust
168
-
`config.json` has this flag to instruct Pattern Lab to append a unique query string to Javascript and CSS assets throughout the frontend.
168
+
`patternlab-config.json` has this flag to instruct Pattern Lab to append a unique query string to Javascript and CSS assets throughout the frontend.
169
169
170
170
```
171
171
"cacheBust": true
@@ -174,7 +174,7 @@ Coupled with exported css (much easier to extract with existing tools like [grun
174
174
Default: true
175
175
176
176
##### defaultPattter
177
-
`config.json` has an entry that allows you to specifiy a specific pattern upon launch of the main site. It works even without BrowserSync running. Set it like this:
177
+
`patternlab-config.json` has an entry that allows you to specifiy a specific pattern upon launch of the main site. It works even without BrowserSync running. Set it like this:
178
178
179
179
```
180
180
"defaultPattern": "pages-homepage",
@@ -204,7 +204,7 @@ You can also exclude complete directories by prepending the directory name with
204
204
205
205
##### Style Guide Excludes
206
206
207
-
Exclude whole pattern types from the "All patterns" styleguide by adding entries to `config.json`. This is quite useful to make speedier. Pattern Lab Node ships with the following:
207
+
Exclude whole pattern types from the "All patterns" styleguide by adding entries to `patternlab-config.json`. This is quite useful to make speedier. Pattern Lab Node ships with the following:
208
208
209
209
```
210
210
"styleGuideExcludes": [
@@ -215,7 +215,7 @@ Exclude whole pattern types from the "All patterns" styleguide by adding entries
215
215
216
216
217
217
##### Debug Mode
218
-
`patternlab.json` is a file created for debugging purposes. Set `debug` to true in `.config.json` to see all the secrets.
218
+
`patternlab.json` is a file created for debugging purposes. Set `debug` to true in `.patternlab-config.json` to see all the secrets.
219
219
220
220
##### Server & BrowserSync
221
221
Running `grunt serve` or `gulp serve` will compile the Pattern Lab frontend and host it by default on <ahref="http://localhost:3000">http://localhost:3000</a> via [BrowserSync](http://www.browsersync.io/docs/). After it starts, templates, `data.json`, and scss/css changes in your source code will be automatically injected into the page.
0 commit comments