Skip to content

docs(attributes): modified related to implementation #1208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 28, 2020
Merged

docs(attributes): modified related to implementation #1208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f3e869e
docs(attributes): removed state attribute announcement #1207
May 12, 2020
4d34c00
docs(attributes): updated as the excludedTags feature got released #8…
May 12, 2020
6f55a97
docs(attributes): corrected the attribute name #844 #1079 #1207
May 12, 2020
bb94602
Merge branch 'dev' into docs-attributes-modified-related-to-implement…
mfranzke May 23, 2020
eb57b75
chore(docs): added another attribute according to #1209 #1207
May 24, 2020
b1b0ee1
docs(tags): added a simple attributes overview #1207
May 24, 2020
eb78818
Merge branch 'dev' into docs-attributes-modified-related-to-implement…
mfranzke May 24, 2020
23db9dd
Merge branch 'dev' into docs-attributes-modified-related-to-implement…
mfranzke May 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions packages/docs/src/docs/advanced-config-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,8 +275,7 @@ Introduced in Pattern Lab Node v3, UIKits are a new term in the Pattern Lab [Eco

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

Important details:

Expand Down
11 changes: 9 additions & 2 deletions packages/docs/src/docs/pattern-documenting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,14 @@ title: Title for my pattern
This is a *Markdown* description of my pattern.
```

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.
Attributes overview:
* The `title` attribute is used in Pattern Lab's navigation as well as in the styleguide views. Format: `string`
* Pattern `tags` has to be an array, like `tags: [new, relaunch, dev]`
* [Pattern `states`](/docs/using-pattern-states/) are defined like `state: incomplete` and [provide a simple visual indication](/docs/using-pattern-states/)

Both `tags` and `states` could be used for [not including patterns in a UIKit specific build](/docs/editing-the-configuration-options/#heading-uikits).

The `description` is used in the styleguide views.

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:

Expand Down Expand Up @@ -46,5 +53,5 @@ We'd name our documentation file:

## Adding More Attributes to the Front Matter

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