Skip to content

Commit b1b0ee1

Browse files
author
Maximilian Franzke
committed
docs(tags): added a simple attributes overview #1207
that includes the tags
1 parent eb57b75 commit b1b0ee1

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

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

Lines changed: 8 additions & 1 deletion
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

0 commit comments

Comments
 (0)