| title | Documenting Patterns | ||||||
|---|---|---|---|---|---|---|---|
| tags |
|
||||||
| category | patterns | ||||||
| eleventyNavigation |
|
||||||
| sitemapPriority | 0.8 | ||||||
| sitemapChangefreq | monthly |
Pattern documentation gives developers and designers the ability to provide context for their patterns and subgroups. The documentation file consists of Markdown with YAML front matter. It should follow this format:
---
title: Title for my pattern
---
This is a *Markdown* description of my pattern.
Attributes overview:
- The
titleattribute is used in Pattern Lab's navigation as well as in the styleguide views. Format:string - Pattern
tagshas to be an array, liketags: [new, relaunch, dev] - Pattern
statesare defined likestate: incompleteand provide a simple visual indication - The
orderproperty to Reorganize Patterns - The
hiddenproperty to Hide Patterns in the Navigation
Both tags and states could be used for not including patterns in a UIKit specific build.
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:
atoms/images/landscape-16x9.mustache
We'd name our documentation file:
atoms/images/landscape-16x9.md
To add documentation to pseudo-patterns, create an companion .md file for that pseudo-pattern.
For example, to document the following pseudo-pattern:
atoms/button/button~red.mustache
We'd name our documentation file:
atoms/button/button~red.md
To document pattern subgroups, you need to create a companion .md file for that subgroup. For example create _patters/atoms/buttons/_buttons.md for a pattern subgroup. In the .md file, the above concept can be applied. The doc-file resolving works the following {patternsRoot}/{pattern-group folder name}/{pattern-sub-group folder name}/_{pattern-sub-group raw name without prefixes}.md
This is a *Markdown* description of the subgroup button.In the future we'll even also provide the possibility to document groups as well.
A future update of Pattern Lab will support more front matter attributes including: excludeFromStyleguide and links. It will also support adding custom attributes that could be utilized by plugins. For example, GitHub issues related to patterns.