Basic workflow
A new documentation frame appears on your canvas with formatted tables and content.
Supported spec types
The plugin reads thetemplateType field to determine which template to use:
templateType | What it creates |
|---|---|
screenReader | VoiceOver, TalkBack, and ARIA accessibility tables |
colorAnnotation | Color token mappings for elements and states |
anatomyOverview | Component structure, variants, and states |
apiOverview | Property tables with values and defaults |
structureSpec | Dimensional specs for spacing and sizing |
changelog | New changelog with entries |
changelogUpdate | Appends entries to an existing changelog |
Changelog update mode
To add entries to an existing changelog:The plugin uses the first existing entry as a template for new entries, maintaining consistent styling.
Tips
- Close other plugins before generating to avoid conflicts
- Have a blank area on the canvas for the new documentation frame
- Review the output and add component previews to placeholder areas