Installation

Add the registry once, then install components with the shadcn CLI.

1. Add the registry

Open components.json and add Wobko to registries. You do this once per project.

components.json
{
  "registries": {
    "@wobko": "https://wobko.dev/r/{name}.json"
  }
}

Free items need no account and no key.

2. Install a component

terminal
npx shadcn@latest add @wobko/button

The CLI writes the component to your ui folder, its drawing code to lib/ink, and the theme to your Tailwind CSS file. It also installs the npm packages the component needs.

To install every component at once:

terminal
npx shadcn@latest add @wobko/wobko

The theme changes your colors

Every component depends on the Wobko theme. Installing it sets the shadcn color variables (--background, --primary and the rest) to the paper palette. If you have other shadcn components in the project, they pick up the same colors.

3. Wrap your app in the provider

The provider holds the settings every drawing reads. Put it once near the root.

tsx
import { InkProvider } from "@/lib/ink/react"

export default function RootLayout({ children }: { children: React.ReactNode }) {
  return (
    <html lang="en">
      <body>
        <InkProvider>{children}</InkProvider>
      </body>
    </html>
  )
}

4. Use it

tsx
import { Button } from "@/components/ui/button"

export function Save() {
  return <Button>Save changes</Button>
}

Next.js

Components that need the browser carry "use client", so you can import them from Server Components in the App Router.

If something is wrong

  • The CLI cannot find @wobko. Check that the registries entry is in the components.json of the project you are running the command in.
  • Components render without the drawing. Check that InkProvider wraps the page and that the theme is in your Tailwind CSS file.
  • Text is not in the hand-drawn font. The theme loads Kevin Sans. If your CSS pipeline drops it, load the font yourself. See Theming.