A Next.js template for building components that are compatible with shadcn/ui CLI.

For more information, please visit shadcn/ui's registry documentation.

npx create-next-app@latest --example "https://github.com/KT83/shadcn-kit"

Build your components in the registry folder.

Add your component config to registry object.

const registry = {
  $schema: "https://ui.shadcn.com/schema/registry.json",
  name: "docs-kit",
  homepage: baseUrl,
  items: [
    {
      name: "button",
      type: "registry:component",
      title: "Button",
      description: "A button component",
      files: [
        {
          path: "registry/button.tsx",
          type: "registry:component",
        },
      ],
    },
    // Add your component config here
  ],
};

Put the server address that your components.json files are hosted. For your local development, it would be http://localhost:PORT_NUMBER.

npm run registry:gen http://localhost:3000

It's built with Next.js, Tailwind CSS, Shadcn/UI, docs-kit and MDX.

Edit config/docs.ts to update sidebar items.

Edit components/global-header.tsx to update header items.