Skip to content
This repository was archived by the owner on May 1, 2020. It is now read-only.

Commit 77dce13

Browse files
committed
Updated command-line page
Updated node docs This is part of pattern-lab/patternlab-node#70 for version 1.0.0 release prep
1 parent fbaefdd commit 77dce13

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

patternlabsite/docs/command-line.md

+21-11
Original file line numberDiff line numberDiff line change
@@ -99,25 +99,35 @@ The version command prints out the current version of Pattern Lab.
9999

100100
{% capture m %}
101101

102-
The following are grunt task arguments you may execute:
102+
The Pattern Lab Node command line interface utilizes grunt or gulp tasks as the primary entry point to perform functions across all platforms. Two JavaScript files, `builer/patternlab_grunt.js` and `builer/patternlab_gulp.js` wrap and expose functions from the vanilla `builder/patternlab.js` engine.
103103

104-
`patternlab`
105-
With no arguments, patternlab runs the full builder, compiling patterns, and constructing the front-end site.
104+
In the following commands, the `grunt|gulp` pairing signifies that both task systems share the same subsequent command.
106105

107-
`patternlab:only_patterns`
108-
Compile the patterns only, outputting to `./public/patterns`
106+
## Generation Commands
109107

110-
`patternlab:v`
111-
Retrieve the version of patternlab-node you have installed
108+
`grunt|gulp patternlab`
112109

113-
`patternlab:help`
114-
Get more information about patternlab-node, pattern lab in general, and where to report issues.
110+
With no arguments, `patternlab `runs the full Pattern Lab Node builder once, removes old content from `public/`, compiles patterns, and moves content from `source/` to `public/`.
115111

116-
These are best suited to encorporate into your `Gruntfile.js` as you see shipped with Pattern Lab Node.
112+
`grunt|gulp patternlab:only_patterns`
113+
114+
Compile the patterns only, outputting to `public/patterns/`. This omits the entire subset of logic that generates the Pattern Lab website.
115+
116+
These are best suited to incorporate into your `Gruntfile.js` or `Gulpfile.s` as you see shipped with Pattern Lab Node.
117+
118+
## Utility Commands
119+
120+
`grunt|gulp patternlab:v`
121+
122+
Retrieve the version of patternlab-node you have installed.
123+
124+
`grunt|gulp patternlab:help`
125+
126+
Get more information about patternlab-node, Pattern Lab in general, and where to report issues.
117127

118128
{% endcapture %}
119129
{{ m | markdownify }}
120130

121131
</div>
122132

123-
<!--- end node -->
133+
<!--- end node -->

0 commit comments

Comments
 (0)