Getting Started
(canary — experimental. APIs here can change without notice.)
The install snippet pins to the version you're reading, so on this page it resolves
to …@canary.
Install
npm install soft-ui-docs@1.0pnpm add soft-ui-docs@1.0yarn add soft-ui-docs@1.0bun add soft-ui-docs@1.0npx jsr add soft-ui-docs@1.0Define a shape (async)
In canary, defineShape() is async — it resolves fonts/image fills first:
import { defineShape } from 'soft-ui-docs'
const card = await defineShape({ corners: 'rounded', radius: 1 })
Start the dev server
npm run devpnpm devyarn devbun run devnpm run devOn 1.0, defineShape() returns synchronously — drop the await. See the
1.0 guide.