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
{{ message }}
This repository was archived by the owner on Dec 10, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
#Contributing to Patternlab - Node
2
2
If you'd like to contribute to patternlab - node, please do so! There is always a lot of ground to cover, with patternlab - php being so feature-rich.
3
3
4
-
No pull request is too small.
4
+
No pull request is too small. Check out any [up for grabs issues](https://github.com/pattern-lab/patternlab-node/labels/up%20for%20grabs) as a good way to get your feet wet.
5
5
6
6
##Guidelines
7
7
1. Please keep your pull requests concise and limited to **ONE** substantive change at a time.
Copy file name to clipboardExpand all lines: README.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,12 @@ This repository contains the vanilla builder logic, grunt and gulp configuration
10
10
11
11
* Download the [latest release of patternlab-node](https://github.com/pattern-lab/patternlab-node/releases/latest) from Github
12
12
* Via npm, run `npm install patternlab-node` (Note this will auto install the grunt version currently. see below)
13
-
***NOTE** Node version 4.X is not officially supported yet, citing [a lot of Windows issues](https://github.com/nodejs/node-gyp/issues/629), including [mine](https://github.com/pattern-lab/patternlab-node/issues/162). Upgrade node at your own risk until otherwise stated.
13
+
***NOTE** Node version 4.X and 5.X have tentative support, citing [a lot of Windows issues](https://github.com/nodejs/node-gyp/issues/629), including [mine](https://github.com/pattern-lab/patternlab-node/issues/162). Upgrade node at your own risk until otherwise stated. I've tried to catalog some issues and troubleshooting steps on the [wiki](https://github.com/pattern-lab/patternlab-node/wiki/Windows-Issues).
14
14
15
15
### Choose Your Adventure! Now Vanilla, Grunt & Gulp
16
16
17
17
This repository ships with two `package.json` files, a `Gruntfile.js`, and a `gulpfile.js`. The default is grunt currently. The core builder is not dependent on either.
18
18
19
-
**HELP WANTED** Please help me test both of the configurations by [reporting](https://github.com/pattern-lab/patternlab-node/blob/dev/CONTRIBUTING.md) any issues encountered.
20
-
21
19
### Getting Started - Grunt
22
20
23
21
To run patternlab-node using grunt, do the following in the directory you downloaded and extracted the zipped release:
@@ -27,7 +25,7 @@ To run patternlab-node using grunt, do the following in the directory you downlo
27
25
* Not deleting `builder/patternlab_gulp.js` may cause a harmless error when running grunt. Delete it.
28
26
3. Run `grunt` or `grunt serve` from the command line
29
27
30
-
This creates all patterns, the styleguide, and the pattern lab site. It's strongly recommended to run `grunt serve` to see have BrowserSync spin up and serve the files to you.
28
+
This creates all patterns, the styleguide, and the pattern lab site. It's strongly recommended to run `grunt serve` to have BrowserSync spin up and serve the files to you.
31
29
32
30
### Getting Started - Gulp
33
31
@@ -51,7 +49,7 @@ It's not expected to toggle between the two build systems, but for those migrati
51
49
52
50
### Upgrading
53
51
54
-
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)
52
+
You can find instructions on how to upgrade from version to version of Pattern Lab Node here: [https://github.com/pattern-lab/patternlab-node/wiki/Upgrading](https://github.com/pattern-lab/patternlab-node/wiki/Upgrading)
55
53
56
54
### Command Line Interface
57
55
@@ -214,6 +212,11 @@ Once rendered, it looks like this:
214
212
</div>
215
213
```
216
214
215
+
You may also specify multiple classes using a pipe character (|).
0 commit comments