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
+39-8Lines changed: 39 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,31 @@ Finally, initiate the generator:
24
24
yo pattern-library
25
25
```
26
26
27
+
#### Generator Setup Steps
28
+
1.**Pattern Library Project Name?**
29
+
30
+
This name will be used at the Title of the Readme as in "[Project Name] Pattern Library"
31
+
32
+
**NOTE:** If this not explicitly set, your current directory name will be added by default. If you decide to change this, you can update the README directly in your project
33
+
34
+
35
+
2.**If this pattern library has been added to Github, please provide the repo name:**
36
+
37
+
Adding the repo name lets you share your project with others (yay!) and allows you to push to gh-pages (more to come on this)
38
+
39
+
**Example:** if your github repo url is "*github.com/organization/org-pattern-library*", then your repository name here would be added as "*org-pattern-library*"
40
+
41
+
**NOTE:** If you skip this question and decide you want/need to add this later, you will need to update the following files with "repo name" values:
42
+
43
+
**package.json**
44
+
45
+
`"name": "repo-name"`
46
+
47
+
**config.yml**
48
+
49
+
`githubrepo: 'repo-name'`
50
+
51
+
27
52
### Build, install, and serve your new pattern library
28
53
29
54
Once the library has been scaffolded by Yeoman, you'll need to run these commands. NOTE: these instructions are in the README of your new pattern library
@@ -94,6 +119,12 @@ If you were going to import the [h1 atoms/text pattern](https://github.com/patte
0 commit comments