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: packages/docs/src/docs/advanced-config-options.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ Sets whether or not to delete `public.patterns/` upon each build of Pattern Lab.
29
29
30
30
### defaultPattern
31
31
32
-
Sets a specific pattern upon launch of the styleguide. This pattern will not be available in the navigation, or in view all pages. The only way to get to it will be via a refresh. Set it using the [short-hand pattern-include syntax](http://localhost:4000/docs/pattern-including.html):
32
+
Sets a specific pattern upon launch of the styleguide. This pattern will not be available in the navigation, or in view all pages. The only way to get to it will be via a refresh. Set it using the [short-hand pattern-include syntax](/docs/including-patterns/):
33
33
34
34
```javascript
35
35
"defaultPattern":"pages-welcome",
@@ -160,7 +160,7 @@ Sets the panel name and language for the code tab on the styleguide. Since this
160
160
161
161
### patternStateCascade
162
162
163
-
See the [Pattern State Documentation](http://patternlab.io/docs/pattern-states.html#node)
163
+
See the [Pattern State Documentation](/docs/using-pattern-states/)
164
164
165
165
**default**:
166
166
@@ -176,7 +176,7 @@ Sets the location that any export operations should output files to. This may be
176
176
177
177
### patternExportPatternPartials
178
178
179
-
Sets an array of patterns (using the [short-hand pattern-include syntax](http://localhost:4000/docs/pattern-including.html)) to be exported after a build.
179
+
Sets an array of patterns (using the [short-hand pattern-include syntax](/docs/including-patterns/)) to be exported after a build.
180
180
181
181
For example, to export the navigation, header, and footer, one might do:
182
182
@@ -200,7 +200,7 @@ Sets live-server options. See the [live-server documentation](https://github.com
200
200
201
201
### starterkitSubDir
202
202
203
-
[Starterkits](http://localhost:4000/docs/advanced-starterkits.html) by convention house their files within the `dist/` directory. Should someone ever wish to change this, this key is available.
203
+
[Starterkits](/docs/starterkits/) by convention house their files within the `dist/` directory. Should someone ever wish to change this, this key is available.
204
204
205
205
**default**:
206
206
@@ -251,7 +251,7 @@ See the [initial release notes](https://github.com/pattern-lab/styleguidekit-ass
251
251
252
252
### uikits
253
253
254
-
Introduced in Pattern Lab Node v3, UIKits are a new term in the Pattern Lab [Ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). They are an evolution of the original Styleguidekit pattern which separated front-end templates from front-end assets like stylesheets and code. The existing `styleguidekit-assets-default` and `styleguidekit-mustache-default` have merged into `uikit-workshop`.
254
+
Introduced in Pattern Lab Node v3, UIKits are a new term in the Pattern Lab [Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/). They are an evolution of the original Styleguidekit pattern which separated front-end templates from front-end assets like stylesheets and code. The existing `styleguidekit-assets-default` and `styleguidekit-mustache-default` have merged into `uikit-workshop`.
255
255
256
256
`uikits` accepts an array of UIKit objects, shipping with the one above.
Copy file name to clipboardExpand all lines: packages/docs/src/docs/advanced-ecosystem-overview.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ Have a trusty set of boilerplate code that you start every project with? Perhaps
35
35
36
36
Importing a starterkit is only a few keystrokes away after installation.
37
37
38
-
[Learn more about Starterkits](/docs/advanced-starterkits.html#node)
38
+
[Learn more about Starterkits](/docs/starterkits/)
39
39
40
40
### StyleguideKits
41
41
@@ -55,4 +55,4 @@ The flexibility of the Pattern Lab ecosystem means that teams can develop tools
55
55
56
56
## Guidance and Help
57
57
58
-
If you have ideas or would like guidance before we have all of the documentation done please learn how you can [engage with the Pattern Lab community](/contribute.html).
58
+
If you have ideas or would like guidance before we have all of the documentation done please learn how you can [engage with the Pattern Lab community](/support/).
Copy file name to clipboardExpand all lines: packages/docs/src/docs/advanced-starterkits.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ eleventyNavigation:
9
9
order: 300
10
10
---
11
11
12
-
Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/advanced-ecosystem-overview.html) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design.
12
+
Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design.
13
13
14
14
## Structure
15
15
@@ -27,7 +27,7 @@ js/
27
27
favicon.ico
28
28
```
29
29
30
-
Teams constructing their own Starterkits should stick to this structure if they wish to publish it externally, else may alter the structure to their [configured `paths`](/docs/advanced-config-options.html#node).
30
+
Teams constructing their own Starterkits should stick to this structure if they wish to publish it externally, else may alter the structure to their [configured `paths`](/docs/editing-the-configuration-options/).
Copy file name to clipboardExpand all lines: packages/docs/src/docs/advanced-template-language-and-pattern-engines.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
@@ -9,7 +9,7 @@ eleventyNavigation:
9
9
order: 300
10
10
---
11
11
12
-
By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/pattern-parameters.html). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats.
12
+
By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats.
13
13
14
14
Right now the most mature PatternEngines are Handlebars, Mustache and Twig.
Copy file name to clipboardExpand all lines: packages/docs/src/docs/data-overview.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,12 @@ The Node version of Pattern Lab only supports JSON.
20
20
There are three places to store data in Pattern Lab:
21
21
22
22
- in `./source/_data`.
23
-
- in [pattern-specific](/docs/data-pattern-specific.html) files in `./source/_patterns`.
24
-
- in [pseudo-pattern](/docs/pattern-pseudo-patterns.html) files in `./source/_patterns`.
23
+
- in [pattern-specific](/docs/creating-pattern-specific-values/) files in `./source/_patterns`.
24
+
- in [pseudo-pattern](/docs/using-pseudo-patterns/) files in `./source/_patterns`.
25
25
26
26
### A Special Note About Pattern Parameters
27
27
28
-
[Pattern parameters](/docs/pattern-parameters.html) are a simple find and replace of variables in the included pattern. As such they do not affect the context stack of Mustache and we don't consider them true data. They have no impact on overall data inheritance and they cannot be used any deeper than the included pattern. They are a hack.
28
+
[Pattern parameters](/docs/using-pattern-parameters/) are a simple find and replace of variables in the included pattern. As such they do not affect the context stack of Mustache and we don't consider them true data. They have no impact on overall data inheritance and they cannot be used any deeper than the included pattern. They are a hack.
Copy file name to clipboardExpand all lines: packages/docs/src/docs/editing-source-files.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,16 +9,16 @@ eleventyNavigation:
9
9
order: 20
10
10
---
11
11
12
-
When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/pattern-managing-assets.html). Each time [your site is generated](/docs/generating-pattern-lab.html) your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory.
12
+
When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/managing-pattern-assets/). Each time your site is generated your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory.
13
13
14
14
## Pattern Lab Directories
15
15
16
16
For the most part you can organize `./source/` anyway you see fit. There are a few Pattern Lab-specific directories though. They are:
17
17
18
-
-`_annotations/` - where your annotations reside. [learn more](/docs/pattern-adding-annotations.html).
19
-
-`_data/` - where the global data used to render your patterns resides. [learn more](/docs/data-overview.html).
20
-
-`_meta/` - where the header and footer that get applied to all of your patterns resides. [learn more](/docs/pattern-header-footer.html).
21
-
-`_patterns/` - where your patterns, pattern documentation, and pattern-specific data reside. [learn more](/docs/pattern-organization.html).
18
+
-`_annotations/` - where your annotations reside. [learn more](/docs/adding-annotations/).
19
+
-`_data/` - where the global data used to render your patterns resides. [learn more](/docs/overview-of-data/).
20
+
-`_meta/` - where the header and footer that get applied to all of your patterns resides. [learn more](/docs/modifying-the-pattern-header-and-footer/).
21
+
-`_patterns/` - where your patterns, pattern documentation, and pattern-specific data reside. [learn more](/docs/reorganizing-patterns/).
22
22
23
23
## Configuring Pattern Lab Directories
24
24
@@ -77,4 +77,4 @@ In the Node version of Pattern Lab you can modify the following configuration op
77
77
78
78
## Watching for Source File Changes
79
79
80
-
Manually generating the Pattern Lab website after each change can be cumbersome. The Node version of Pattern Lab comes with the ability to [watch files in the `./source/` directory for changes and re-generate the site automatically](/docs/advanced-auto-regenerate.html). The Pattern Lab website can also be [automatically reloaded](/docs/advanced-reload-browser.html).
80
+
Manually generating the Pattern Lab website after each change can be cumbersome. The Node version of Pattern Lab comes with the ability to watch files in the `./source/` directory for changes and re-generate the site automatically. The Pattern Lab website can also be automatically reloaded..
Copy file name to clipboardExpand all lines: packages/docs/src/docs/installation.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ This will bring up an installation menu that presents the following steps:
38
38
39
39
## Step 5: Choose initial patterns
40
40
41
-
**`What initial patterns do you want included in your project?`** - Choose the <ahref="/docs/advanced-starterkits.html">Starterkit</a> you want to begin your project with. The options are:
41
+
**`What initial patterns do you want included in your project?`** - Choose the <ahref="/docs/starterkits/">Starterkit</a> you want to begin your project with. The options are:
42
42
43
43
-**`Handlebars base patterns`**`(some basic patterns to get started with)` - TODO: include demo link
44
44
-**`Handlebars demo patterns`**`(full demo website and patterns)` - TODO: include demo link
@@ -50,4 +50,3 @@ This will bring up an installation menu that presents the following steps:
50
50
51
51
**`Are you happy with your choices? (Hit enter for YES)?`** - Confirm your choices, and when done the Pattern Lab installation will begin.
52
52
53
-
Once installation is complete, you're ready to <ahref="/docs/generating-pattern-lab.html">generate Pattern Lab for the first time.</a>
Copy file name to clipboardExpand all lines: packages/docs/src/docs/pattern-converting.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
@@ -9,7 +9,7 @@ eleventyNavigation:
9
9
order: 190
10
10
---
11
11
12
-
You may have invested time in building patterns for Brad's original edition of Pattern Lab but now want to convert them so they can be used with the new PHP version of Pattern Lab. To convert them all you need to do is swap out the old `inc()` calls for the Mustache-based [shorthand partials syntax](/docs/pattern-including.html). For example, let's say this was a call to a pattern using the original syntax:
12
+
You may have invested time in building patterns for Brad's original edition of Pattern Lab but now want to convert them so they can be used with the new PHP version of Pattern Lab. To convert them all you need to do is swap out the old `inc()` calls for the Mustache-based [shorthand partials syntax](/docs/including-patterns/). For example, let's say this was a call to a pattern using the original syntax:
0 commit comments