Documentation for 0.8.0
Build your design system. Reuse it everywhere. Iterate in one place.
Pattern Dump renders Handlebars components with JSON data, checks accessibility in every build and publishes sites like this one. This page is the whole map of the docs.
Guide
How to build a design system with Pattern Dump, step by step, from an empty folder to a style guide you run, check and publish.
- Create a style guideStart a style guide with pd init, the style guide generator in Pattern Dump, and learn what each question means and what each file it writes is for.
- Run the workbenchStart pd dev and find your way around the workbench, the part of Pattern Dump where your components render, with their docs, themes and checks beside them.
- Add a componentAdd a component to your style guide: a Handlebars template with its data, its component documentation and a schema, then give it a variant.
- Style a componentStyle a component in Pattern Dump with a stylesheet of its own, a rule in the base layer and CSS design tokens in your themes, then switch themes in the workbench.
- Check your workAutomated accessibility testing and checks for every component in Pattern Dump: the Diagnostics tab while you work, and pd audit for the whole style guide.
- Add a page to your siteWrite a page for your design system website in markdown, with a live example of your own component, and see it in pd dev beside the workbench.
- A site on a style guideKeep a style guide and its website as two Pattern Dump projects in one repository: the style guide as a package, the site as content only.
- PublishBuild your style guide and its site with pd build, fix what the build refuses, and publish both as a GitHub Pages static site or on any host.
- UpgradeMove Pattern Dump to a new version: the exact npm version your project pins, what to read first, and what changed in 0.8 and 0.7.
The idea
What Pattern Dump is for: one place for a design system's components, their documentation, their checks and the site built from them.
Concepts
What Pattern Dump does with your design system and why, explained one idea at a time.
Reference
Every key, command and file of Pattern Dump, to look up by name.
In practice
Sites built with Pattern Dump, this one and the demo: their repositories, style guides and how they are published, shown from their own files.
Pages
Everything else.
Built with Pattern Dump
Real sites, with the style guides behind them.