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 Feb 7, 2023. It is now read-only.
Copy file name to clipboardexpand all lines: README.md
+10-9
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,7 @@ The Grunt Edition comes with the following components:
13
13
14
14
## Prerequisites
15
15
16
-
Pattern Lab Node uses [Node](https://nodejs.org) and [npm](https://www.npmjs.com/) to manage project dependencies, and [grunt](http://gruntjs.com/) to run tasks and interface with core.
17
-
18
-
Please follow the directions for [installing Node](https://nodejs.org/en/download/) on the Node website. This should include `npm`.
16
+
The Pattern Lab Node - Grunt Edition uses [Node](https://nodejs.org) for core processing, [npm](https://www.npmjs.com/) to manage project dependencies, and [grunt.js](http://gruntjs.com/) to run tasks and interface with the core library. Node version 4 or higher suffices. You can follow the directions for [installing Node](https://nodejs.org/en/download/) on the Node website if you haven't done so already. Installation of Node will include npm.
19
17
20
18
It's also highly recommended that you [install grunt](http://gruntjs.com/getting-started) globally.
21
19
@@ -28,19 +26,22 @@ There are two methods for downloading and installing the Grunt Edition:
28
26
29
27
### Download a pre-built package
30
28
31
-
The fastest way to get started with the Grunt Edition is to [download the pre-built version](https://github.com/pattern-lab/edition-node-gulp/releases) from the [releases page](https://github.com/pattern-lab/edition-node-gulp/releases). The pre-built project comes with the [Default Starterkit for Mustache](https://github.com/pattern-lab/starterkit-mustache-default/tree/dev) installed by default.
29
+
The fastest way to get started with the Grunt Edition is to [download the pre-built version](https://github.com/pattern-lab/edition-node-gulp/releases) from the [releases page](https://github.com/pattern-lab/edition-node-gulp/releases). The pre-built project comes with the [Base Starterkit for Mustache](https://github.com/pattern-lab/starterkit-mustache-base) installed by default.
32
30
33
31
**Please note:** Pattern Lab Node uses [npm](https://www.npmjs.com/) to manage project dependencies. To upgrade the Grunt Edition or to install plug-ins you'll need to be familiar with npm.
34
32
35
33
### Use npm
36
34
37
35
`npm` is a dependency management and package system which can pull in all of the Grunt Edition's dependencies for you. To accomplish this:
38
36
39
-
* download or clone this repository to an install location.
37
+
* download or `git clone` this repository to an install location.
40
38
41
39
* run the following
40
+
41
+
```
42
42
cd install/location
43
43
npm install
44
+
```
44
45
45
46
Running `npm install` from a directory containing a `package.json` file will download all dependencies defined within.
46
47
@@ -67,19 +68,19 @@ These are some helpful commands you can use on the command line for working with
67
68
68
69
To list all available commands type:
69
70
70
-
grunt pl-help
71
+
grunt patternlab:help
71
72
72
73
### Generate Pattern Lab
73
74
74
75
To generate the front-end for Pattern Lab type:
75
76
76
-
grunt pl-build
77
+
grunt patternlab:build
77
78
78
79
### Watch for changes and re-generate Pattern Lab
79
80
80
81
To watch for changes, re-generate the front-end, and server it via a BrowserSync server, type:
81
82
82
-
grunt pl-serve
83
+
grunt patternlab:serve
83
84
84
85
BrowserSync should open [http://localhost:3000](http://localhost:3000) in your browser.
85
86
@@ -89,4 +90,4 @@ To install a specific StarterKit from GitHub type:
Copy file name to clipboardexpand all lines: package.json
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
{
2
2
"name": "edition-node-grunt",
3
3
"description": "The grunt wrapper around patternlab-node core, providing tasks to interact with the core library and move supporting frontend assets.",
"short" : "Lorem ipsum dolor sit (37 characters)",
29
-
"medium" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit. (72 characters)"
30
-
},
31
-
"excerpt" : {
32
-
"short" : "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam",
33
-
"medium" : "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
34
-
"long" : "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
35
-
},
36
-
"description" : "So, setting about it as methodically as men might smoke out a wasps' nest, the Martians spread this strange stifling vapour over the Londonward country. The horns of the crescent slowly moved apart, until at last they formed a line from Hanwell to Coombe and Malden. All night through their destructive tubes advanced.",
37
-
"url" : "#",
38
-
"name" : {
39
-
"first": "Lacy",
40
-
"firsti": "L",
41
-
"middle": "Tommie",
42
-
"middlei": "T",
43
-
"last": "Way",
44
-
"lasti": "W"
45
-
},
46
-
"year" : {
47
-
"long": "2013",
48
-
"short": "13"
49
-
},
50
-
"month" : {
51
-
"long": "February",
52
-
"short": "Feb",
53
-
"digit": "02"
54
-
},
55
-
"dayofweek" : {
56
-
"long": "Monday",
57
-
"short": "Mon"
58
-
},
59
-
"day" : {
60
-
"long": "10",
61
-
"short": "10",
62
-
"ordinal": "th"
63
-
},
64
-
"hour" : {
65
-
"long": "01",
66
-
"short": "1",
67
-
"military": "13",
68
-
"ampm": "pm"
69
-
},
70
-
"minute" : {
71
-
"long": "20",
72
-
"short": "20"
73
-
},
74
-
"seconds" : "31",
75
-
"author" : {
76
-
"first-name": "Author",
77
-
"last-name": "Name"
78
-
},
79
-
"hero": true,
80
-
"emergency" : false,
81
-
"touts" : [
82
-
{ },
83
-
{ },
84
-
{ }
85
-
],
86
-
"latest-posts" : [
87
-
{ },
88
-
{ },
89
-
{ },
90
-
{ },
91
-
{ }
92
-
]
93
-
}
2
+
"key": "value",
3
+
"key2": "use this for variables you want to load globally",
"short": "Shizz fo shizzle mah nizzle fo rizzle, mah home g-dizzle, gravida vizzle, arcu. Pellentesque crunk tortizzle. Sed erizzle. Black izzle sheezy telliv.",
33
+
"medium": "Izzle crazy tempizzle sizzle. We gonna chung gangsta get down get down fo shizzle turpizzle. Away break it down black. Pellentesque bling bling rhoncus fo shizzle. In hac the bizzle platea dictumst. Black dapibizzle. Crackalackin.",
34
+
"long": "Curabitizzle fo shizzle diam quizzle nisi nizzle mollizzle. Suspendisse boofron. Morbi odio. Sure pizzle. Crazy orci. Shut the shizzle up maurizzle get down get down, check out this a, go to hizzle sit amizzle, malesuada izzle, pede. Pellentesque gravida. Vestibulizzle check it out mi, volutpat izzle, shiz sed, shiznit sempizzle, da bomb. Funky fresh in ipsum. Da bomb volutpat felis vizzle daahng dawg. Crizzle quis dope izzle fo shizzle my ni."
35
+
},
36
+
"description": "Fizzle crazy tortor. Sed rizzle. Ass pimpin' dolor dapibizzle turpis tempizzle fo shizzle my nizzle. Maurizzle pellentesque its fo rizzle izzle turpis. Get down get down we gonna chung nizzle. Shizzlin dizzle eleifend rhoncizzle break it down. In yo ghetto platea dictumst. Bling bling dapibizzle. Curabitur break yo neck, yall fo, pretizzle eu, go to hizzle dope, own yo' vitae, nunc. Bizzle suscipizzle. Ass semper velit sizzle fo.",
0 commit comments