@@ -19,21 +19,20 @@ const patternlab = require('@pattern-lab/core')(config);
1919Build thoughtful, pattern-driven user interfaces using atomic design principles.
2020Many of these functions are exposed to users within [ Editions] ( https://github.com/pattern-lab/patternlab-node#editions ) , but [ direct consumption] ( https://github.com/pattern-lab/patternlab-node#direct-consumption ) is also encouraged.
2121
22- ** Kind** : global namespace
22+ ** Kind** : global namespace
2323** See**
2424
2525- [ patternlab.io] ( patternlab.io ) for more documentation.
2626- [ https://github.com/pattern-lab/patternlab-node ] ( https://github.com/pattern-lab/patternlab-node ) for code, issues, and releases
2727
28- ** License** : MIT
28+ ** License** : MIT
2929
3030* [ ` patternlab ` ] ( #patternlab ) : <code >object</code >
3131 * _ instance_
3232 * [ ` .version ` ] ( #patternlab+version ) ⇒ <code >string</code >
3333 * [ ` .build ` ] ( #patternlab+build ) ⇒ <code >Promise</code >
3434 * [ ` .getDefaultConfig ` ] ( #patternlab+getDefaultConfig ) ⇒ <code >object</code >
3535 * [ ` .getSupportedTemplateExtensions ` ] ( #patternlab+getSupportedTemplateExtensions ) ⇒ <code >Array.< ; string> ; </code >
36- * [ ` .installplugin ` ] ( #patternlab+installplugin ) ⇒ <code >void</code >
3736 * [ ` .liststarterkits ` ] ( #patternlab+liststarterkits ) ⇒ <code >Promise</code >
3837 * [ ` .loadstarterkit ` ] ( #patternlab+loadstarterkit ) ⇒ <code >void</code >
3938 * [ ` .patternsonly ` ] ( #patternlab+patternsonly ) ⇒ <code >Promise</code >
@@ -51,17 +50,17 @@ Many of these functions are exposed to users within [Editions](https://github.co
5150### ` patternlab.version ` ⇒ <code >string</code >
5251Returns current version
5352
54- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
55- ** Returns** : <code >string</code > - current patternlab-node version as defined in ` package.json ` , as string
53+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
54+ ** Returns** : <code >string</code > - current patternlab-node version as defined in ` package.json ` , as string
5655<a name =" patternlab+build " ></a >
5756
5857### ` patternlab.build ` ⇒ <code >Promise</code >
5958Builds patterns, copies assets, and constructs user interface
6059
61- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
62- ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
63- ** Emits** : <code >event: PATTERNLAB_BUILD_START </code >, <code >event: PATTERNLAB_BUILD_END </code >
64- ** See** : [ all events] ( ./events.md )
60+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
61+ ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
62+ ** Emits** : <code >event: PATTERNLAB_BUILD_START </code >, <code >event: PATTERNLAB_BUILD_END </code >
63+ ** See** : [ all events] ( ./events.md )
6564
6665| Param | Type | Default | Description |
6766| --- | --- | --- | --- |
@@ -75,39 +74,29 @@ Builds patterns, copies assets, and constructs user interface
7574### ` patternlab.getDefaultConfig ` ⇒ <code >object</code >
7675Returns the standardized default config used to run Pattern Lab. This method can be called statically or after instantiation.
7776
78- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
79- ** Returns** : <code >object</code > - Returns the object representation of the ` patternlab-config.json `
77+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
78+ ** Returns** : <code >object</code > - Returns the object representation of the ` patternlab-config.json `
8079<a name =" patternlab+getSupportedTemplateExtensions " ></a >
8180
8281### ` patternlab.getSupportedTemplateExtensions ` ⇒ <code >Array.< ; string> ; </code >
8382Returns all file extensions supported by installed PatternEngines
8483
85- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
86- ** Returns** : <code >Array.< ; string> ; </code > - all supported file extensions
87- <a name =" patternlab+installplugin " ></a >
88-
89- ### ` patternlab.installplugin ` ⇒ <code >void</code >
90- Installs plugin already available via ` node_modules/ `
91-
92- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
93-
94- | Param | Type | Description |
95- | --- | --- | --- |
96- | pluginName | <code >string</code > | name of plugin |
84+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
85+ ** Returns** : <code >Array.< ; string> ; </code > - all supported file extensions
9786
9887<a name =" patternlab+liststarterkits " ></a >
9988
10089### ` patternlab.liststarterkits ` ⇒ <code >Promise</code >
10190Fetches starterkit repositories from pattern-lab github org that contain 'starterkit' in their name
10291
103- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
104- ** Returns** : <code >Promise</code > - Returns an Array<{name,url}> for the starterkit repos
92+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
93+ ** Returns** : <code >Promise</code > - Returns an Array<{name,url}> for the starterkit repos
10594<a name =" patternlab+loadstarterkit " ></a >
10695
10796### ` patternlab.loadstarterkit ` ⇒ <code >void</code >
10897Loads starterkit already available via ` node_modules/ `
10998
110- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
99+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
111100
112101| Param | Type | Description |
113102| --- | --- | --- |
@@ -119,8 +108,8 @@ Loads starterkit already available via `node_modules/`
119108### ` patternlab.patternsonly ` ⇒ <code >Promise</code >
120109Builds patterns only, leaving existing user interface files intact
121110
122- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
123- ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
111+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
112+ ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
124113
125114| Param | Type | Default | Description |
126115| --- | --- | --- | --- |
@@ -133,21 +122,21 @@ Builds patterns only, leaving existing user interface files intact
133122### ` patternlab.getDefaultConfig ` ⇒ <code >object</code >
134123Static method that returns the standardized default config used to run Pattern Lab. This method can be called statically or after instantiation.
135124
136- ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
137- ** Returns** : <code >object</code > - Returns the object representation of the ` patternlab-config.json `
125+ ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
126+ ** Returns** : <code >object</code > - Returns the object representation of the ` patternlab-config.json `
138127<a name =" patternlab.getVersion " ></a >
139128
140129### ` patternlab.getVersion ` ⇒ <code >string</code >
141130Static method that returns current version
142131
143- ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
144- ** Returns** : <code >string</code > - current @pattern-lab/core version as defined in ` package.json `
132+ ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
133+ ** Returns** : <code >string</code > - current @pattern-lab/core version as defined in ` package.json `
145134<a name =" patternlab.server " ></a >
146135
147136### ` patternlab.server ` : <code >object</code >
148137Server module
149138
150- ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
139+ ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
151140
152141* [ ` .server ` ] ( #patternlab.server ) : <code >object</code >
153142 * [ ` .serve(options) ` ] ( #patternlab.server.serve ) ⇒ <code >Promise</code >
@@ -159,8 +148,8 @@ Server module
159148#### ` server.serve(options) ` ⇒ <code >Promise</code >
160149Build patterns, copies assets, and constructs user interface. Watches configured ` source/ ` directories, and serves all output locally
161150
162- ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
163- ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
151+ ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
152+ ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
164153
165154| Param | Type | Default | Description |
166155| --- | --- | --- | --- |
@@ -174,19 +163,19 @@ Build patterns, copies assets, and constructs user interface. Watches configured
174163#### ` server.reload() ` ⇒ <code >Promise</code >
175164Reloads any active live-server instances
176165
177- ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
178- ** Returns** : <code >Promise</code > - a promise fulfilled when operation is complete
166+ ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
167+ ** Returns** : <code >Promise</code > - a promise fulfilled when operation is complete
179168<a name =" patternlab.server.refreshCSS " ></a >
180169
181170#### ` server.refreshCSS() ` ⇒ <code >Promise</code >
182171Reloads CSS on any active live-server instances
183172
184- ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
185- ** Returns** : <code >Promise</code > - a promise fulfilled when operation is complete
173+ ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
174+ ** Returns** : <code >Promise</code > - a promise fulfilled when operation is complete
186175<a name =" patternlab.events " ></a >
187176
188177### ` patternlab.events ` : <code >EventEmitter</code >
189- ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
178+ ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
190179** See**
191180
192181- [ EventEmitter] ( https://nodejs.org/api/events.html#events_class_eventemitter )
0 commit comments