Does my design system documentation in Knapsack update automatically?
Yes, documentation created using Example or Embed content blocks is updated automatically as the source data is updated.
Example content blocks enable editors to document the design system elements using source code from the repository - design tokens and coded templates (simple and complex components). Documentation created with these blocks will update automatically when changes to the source code are committed to the main branch of the repo:
- Design Tokens
- Pattern List
- Pattern Status Table
- Pattern Example
- Pattern Variations
Embed content blocks enable editors to document the design system elements and resources that live outside of the repo, or in other tools, without duplicating content. Documentation created with these blocks will update automatically when changes are made to the source content or experience that has been embedded:
- Abstract Embed
- Adobe XD Embed
- Airtable Embed
- Figma Embed
- Framer Cloud Embed
- Lucidchart Embed
- YouTube Embed
- Whimsical Embed
- Generic iFrame Embed
In addition to content created using content blocks, code tabs added to Pattern Pages include automated documentation for Engineers:
- Usage shows Developers the exact code they would need to use in production to create the example configured in Knapsack
- API Documentation shows the specification for available properties and slots in table format based on the defined data schema for the pattern
For more information on editing documentation and content blocks, see Creating Documentation.
For more information on modifying pattern data schema, see Pattern Props and Slots