Getting Started
Get the docs running locally in under a minute. (v1.0 — the current stable release.)
Commands below follow the package manager and version you pick in the
navbar. The install snippet pins to the version you're reading, so on this page it
resolves to …@1.0.
Install
npm install soft-ui-docs@0.9.90pnpm add soft-ui-docs@0.9.90yarn add soft-ui-docs@0.9.90bun add soft-ui-docs@0.9.90npx jsr add soft-ui-docs@0.9.90Define a shape
In 1.0 the API is defineShape(), which returns a Shape synchronously:
import { defineShape } from 'soft-ui-docs'
const card = defineShape({ corners: 'rounded', radius: 1 })
Start the dev server
npm run devpnpm devyarn devbun run devnpm run devOpen http://localhost:3000 — edits to any .mdx file
under content/ hot-reload instantly.
Coming from 0.9? createShape() was renamed to defineShape() and now returns
the Shape directly instead of a thunk. Switch the picker to v0.9 for the old guide.