Inkbridgeinkbridge
← Documentation

Getting started

From zero to a live design system in Figma — in about 10 minutes.

Before you begin

Make sure your project has all of these:

  • Figma Desktop — the browser version blocks localhost connections. Download from figma.com/downloads
  • Node.js 22 — check with node --version
  • pnpm — install with npm i -g pnpm if missing
  • Next.js project with TypeScript and Tailwind CSS (v3 or v4)
  • Storybook set up with at least a few *.stories.tsx files — the plugin scans these to generate Figma frames

Setup steps

1

Install inkbridge

In your project root:

pnpm add -D inkbridge
pnpm exec inkbridge setup

setup creates both scanner/token API endpoints (/api/figma/scan-components and /api/figma/patch-tokens) and adds figma:dev and figma:scan scripts to your package.json automatically.

2

Load the plugin in Figma Desktop

Go to Plugins → Development → Import plugin from manifest and select:

node_modules/inkbridge/manifest.json

Figma remembers this path — you only do this once. Your component data is always scanned live on each generate. Run pnpm update inkbridge only when a new inkbridge version is released with rendering improvements.

3

Start your dev server

Start your Next.js dev server:

pnpm figma:dev

The plugin auto-discovers your server on port 4000, 3000, or 5173 — whichever responds first.

4

Generate your design system

In Figma Desktop go to Plugins → Development → Inkbridge → Generate Design System Page.

The plugin scans your Storybook stories on demand and builds a dedicated Design System page in Figma with colour tokens, typography, spacing, and every component variant.

Plugin shows “Dev server not running”? Make sure pnpm figma:dev is running in your terminal, then click Retry inside the plugin.

What to do next