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/installation.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
@@ -42,7 +42,7 @@ This will bring up an installation menu that presents the following steps:
42
42
43
43
## Step 5: Choose initial patterns
44
44
45
-
**`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:
45
+
**`What initial patterns do you want included in your project?`** - Choose the [Starterkit](/docs/starterkits/) you want to begin your project with. The options are:
46
46
47
47
-**`Handlebars base patterns`**`(some basic patterns to get started with)`
48
48
-**`Handlebars demo patterns`**`(full demo website and patterns)`
Copy file name to clipboardExpand all lines: packages/docs/src/docs/pattern-including.md
+2-7Lines changed: 2 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ The shorthand include syntax would be:
30
30
31
31
atoms-landscape-16x9
32
32
33
-
The pattern type matches the top-level folder and is `atoms`. The pattern name matches the template file and is `landscape-16x9`. Any digits used for ordering are _dropped_ from both the pattern type and pattern name. Pattern subgroups are _never_ a part of the shorthand include syntax. This way patterns can be re-organized within a pattern type and/or by using digits without needing to change your pattern includes.
33
+
The pattern type matches the top-level folder and is `atoms`. The pattern name matches the template file and is `landscape-16x9`. Any digits used in the filename for ordering (which is deprecated, use [the order parameter](/docs/reorganizing-patterns/) instead) are _dropped_ from both the pattern type and pattern name references. Pattern subgroups are _never_ a part of the shorthand include syntax. This way patterns can be re-organized within a pattern type and/or by using digits (which is deprecated, use [the order parameter](/docs/reorganizing-patterns/) instead) without needing to change your pattern includes.
34
34
35
35
The following are examples of using the shorthand include syntax with our supported PatternEngines:
36
36
@@ -60,7 +60,7 @@ The default Mustache include syntax would be:
60
60
{% raw %}{{> atoms/images/landscape-16x9 }}{% endraw %}
61
61
```
62
62
63
-
**Important:** Unlike the shorthand include syntax the template language specific include syntax **must** include any digits used for ordering and subgroup directories. Pattern paths need to be updated when either is changed for a given pattern.
63
+
**Important:** Unlike the shorthand include syntax the template language specific include syntax **must** include any digits used for ordering (which is deprecated, use [the order parameter](/docs/reorganizing-patterns/) instead) and subgroup directories. Pattern paths need to be updated when either is changed for a given pattern.
64
64
65
65
## Examples and Gotchas
66
66
@@ -69,17 +69,12 @@ Here are some examples of how to include patterns as well as some gotchas.
69
69
```handlebars
70
70
{% raw %}// partials to match
71
71
atoms/global/test.mustache
72
-
atoms/global/test.mustache
73
-
atoms/global/test.mustache
74
72
atoms/global/test-with-picture.mustache
75
73
76
74
// using the shorthand partials syntax
77
75
{{> atoms-test }} // will match atoms/global/test.mustache
78
-
// using the shorthand syntax you'll never be able to match test nor test in this scenario
79
76
{{> atoms-test-with-picture }} // will match atoms/global/test-with-picture.mustache
80
-
{{> atoms-test-wit }} // will match atoms/global/test-with-picture.mustache
81
77
82
78
// using the default mustache partials syntax
83
-
{{> atoms/global/test }} // won't match anything because atoms is missing its digits
84
79
{{> atoms/global/test }} // will match atoms/global/test.mustache{% endraw %}
0 commit comments