Open-Source

Your components
documented automatically

PatternBook statically analyses your React & TypeScript components to generate a living design system with live previews, prop tables, and source code, with no configuration required.

See it in action
Button — PatternBook
Button function
A customizable button with multiple variants and sizes.
PropTypeDefaultDescription
variantstring"primary"Visual style variant
sizestring"md"Button size
disabledbooleanfalseDisables interaction
<Button variant="primary" > Click me </Button>

Everything your design system needs.

From zero to a living, searchable component library — with no config required.

Zero Config

Point PatternBook at your components folder and it handles the rest. No YAML, no decorators, no annotations.

👁️

Live Previews

Every example is rendered live in the browser. Edit the code inline and watch the preview update in real time.

📋

Auto Prop Tables

TypeScript types and JSDoc comments are extracted automatically into a searchable, filterable prop reference.

🔍

Smart Search

Find any component instantly by name, description, or tag. Categories keep everything organised as your library grows.

🔄

Always Up-to-Date

PatternBook watches your files and regenerates the manifest on every save. Your docs can never fall out of sync.

🔬

Source Code Viewer

View the full source of any component with syntax highlighting, right alongside the rendered preview.

From components to docs in seconds

01

Install the CLI

Install PatternBook in your project. No config files, no boilerplate — it works with your existing structure.

npm i patternbook-cli
02

Generate the manifest

Point PatternBook at your components folder. It statically analyses every component — extracting props, descriptions, and source code.

npx patternbook generate
03

Serve & share

Launch the live viewer and browse your design system in the browser. Share the URL with your team instantly.

npx patternbook serve

Ready to ship your design system?

Get PatternBook running in your project in under five minutes.