Skip to content

Commit caaaa7b

Browse files
authored
Merge pull request #1208 from mfranzke/docs-attributes-modified-related-to-implementation
docs(attributes): modified related to implementation
2 parents 869e271 + 23db9dd commit caaaa7b

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

packages/docs/src/docs/advanced-config-options.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,8 +294,7 @@ Introduced in Pattern Lab Node v3, UIKits are a new term in the Pattern Lab [Eco
294294

295295
- `enabled`: quickly turn on or off the building of this UIKit
296296
- `excludedPatternStates`: tell Pattern Lab not to include patterns with these states in this UIKit's output
297-
- `excludedPatternTags`: tell Pattern Lab not to include patterns with these tags in this UIKit's output
298-
- [currently not supported](https://github.com/pattern-lab/patternlab-node/issues/844)
297+
- `excludedTags`: tell Pattern Lab not to include patterns with these tags in this UIKit's output
299298

300299
Important details:
301300

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,14 @@ title: Title for my pattern
1818
This is a *Markdown* description of my pattern.
1919
```
2020

21-
The `title` attribute is used in Pattern Lab's navigation as well as in the styleguide views. The `description` is used in the styleguide views.
21+
Attributes overview:
22+
* The `title` attribute is used in Pattern Lab's navigation as well as in the styleguide views. Format: `string`
23+
* Pattern `tags` has to be an array, like `tags: [new, relaunch, dev]`
24+
* [Pattern `states`](/docs/using-pattern-states/) are defined like `state: incomplete` and [provide a simple visual indication](/docs/using-pattern-states/)
25+
26+
Both `tags` and `states` could be used for [not including patterns in a UIKit specific build](/docs/editing-the-configuration-options/#heading-uikits).
27+
28+
The `description` is used in the styleguide views.
2229

2330
Pattern documentation needs to have a `.md` file extension and match the name of the pattern it's documenting. For example, to document the following pattern:
2431

@@ -46,5 +53,5 @@ We'd name our documentation file:
4653

4754
## Adding More Attributes to the Front Matter
4855

49-
A future update of Pattern Lab will support more front matter attributes including: state, order, hidden, links and tags.
56+
A future update of Pattern Lab will support more front matter attributes including: excludeFromStyleguide, order, hidden and links.
5057
It will also support adding custom attributes that could be utilized by plugins. For example, GitHub issues related to patterns.

0 commit comments

Comments
 (0)