Skip to content

Commit 4617540

Browse files
committed
Merge remote-tracking branch 'upstream/dev' into dev
2 parents 51c1d00 + a4448e6 commit 4617540

File tree

2 files changed

+3
-8
lines changed

2 files changed

+3
-8
lines changed

packages/docs/src/docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This will bring up an installation menu that presents the following steps:
4242

4343
## Step 5: Choose initial patterns
4444

45-
**`What initial patterns do you want included in your project?`** - Choose the <a href="/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:
4646

4747
- **`Handlebars base patterns`** `(some basic patterns to get started with)`
4848
- **`Handlebars demo patterns`** `(full demo website and patterns)`

packages/docs/src/docs/pattern-including.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The shorthand include syntax would be:
3030

3131
atoms-landscape-16x9
3232

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.
3434

3535
The following are examples of using the shorthand include syntax with our supported PatternEngines:
3636

@@ -60,7 +60,7 @@ The default Mustache include syntax would be:
6060
{% raw %}{{> atoms/images/landscape-16x9 }}{% endraw %}
6161
```
6262

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.
6464

6565
## Examples and Gotchas
6666

@@ -69,17 +69,12 @@ Here are some examples of how to include patterns as well as some gotchas.
6969
```handlebars
7070
{% raw %}// partials to match
7171
atoms/global/test.mustache
72-
atoms/global/test.mustache
73-
atoms/global/test.mustache
7472
atoms/global/test-with-picture.mustache
7573
7674
// using the shorthand partials syntax
7775
{{> 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
7976
{{> atoms-test-with-picture }} // will match atoms/global/test-with-picture.mustache
80-
{{> atoms-test-wit }} // will match atoms/global/test-with-picture.mustache
8177
8278
// using the default mustache partials syntax
83-
{{> atoms/global/test }} // won't match anything because atoms is missing its digits
8479
{{> atoms/global/test }} // will match atoms/global/test.mustache{% endraw %}
8580
```

0 commit comments

Comments
 (0)