Skip to content
This repository was archived by the owner on Dec 10, 2019. It is now read-only.

Commit 89c4d33

Browse files
committed
feat(package): Add placeholders
1 parent dac6ba9 commit 89c4d33

File tree

7 files changed

+30
-0
lines changed

7 files changed

+30
-0
lines changed

source/_annotations/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This is the default location to place annotations.
2+
3+
Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](http://patternlab.io/docs/pattern-adding-annotations.html).
4+
5+
If you wish to rename this directory, make sure you update the `paths.source.annotations` property within `patternlab-config.json`.

source/_data/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This is the default location to place global data files.
2+
3+
Pattern Lab uses data defined here as the global fallback if a template does not provide its own data. Read more about [data](http://patternlab.io/docs/data-overview.html).
4+
5+
If you wish to rename this directory, make sure you update the `paths.source.data` property within `patternlab-config.json`.

source/_meta/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This is the default location to place meta files, otherwise known a pattern's header and footer.
2+
3+
Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](http://patternlab.io/docs/pattern-header-footer.html).
4+
5+
If you wish to rename this directory, make sure you update the `paths.source.meta` property within `patternlab-config.json`.

source/_patterns/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This is the default location to place pattern files.
2+
3+
Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](http://patternlab.io/docs/pattern-organization.html).
4+
5+
If you wish to rename this directory, make sure you update the `paths.source.patterns` property within `patternlab-config.json`.

source/css/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This is the default location to place global css files.
2+
3+
The entire contents of this directory will be recursively copied to your configured `public/` directory.
4+
5+
If you wish to rename this directory, make sure you update the `paths.source.css` property within `patternlab-config.json`.

source/favicon.ico

32.2 KB
Binary file not shown.

source/fonts/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This is the default location to place global font files.
2+
3+
The entire contents of this directory will be recursively copied to your configured `public/` directory.
4+
5+
If you wish to rename this directory, make sure you update the `paths.source.fonts` property within `patternlab-config.json`.

0 commit comments

Comments
 (0)