mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-07-08 22:45:47 +00:00
* feat(v4): update home page * fix * fix: cards * feat(v4): charts page * feat: update pages * feat: colors * fix * feat: add docs * feat: mdx work * fix * fix * fix: sidebar * fix: lint * feat: updates * feat: update components * feat: fix docs * fix: responsive * feat: implement cmdk * fix: update navigation menu demo * fix: code style * fix: themes * feat: implement blocks page * fix: docs config * refactor * fix: outputFileTracingIncludes * fix * fix: output * fix * fix: registry * refactor: move docs * debug: docs * debug * revert * fix: mjs * deps: pin fumadocs * debug * fix: downgrade next * fix: index page * refactor: move mdx components * fix: remove copy button * fix * was it zod * yes it was * remove copy page * fix: color page * fix: colors page * fix: meta colors * fix: copy button * feat: sync registry * fix: registry build script * feat: update port * feat: clean up examples * fix * fix: mobile nav * fix: blur for mobile * fix: sidebar nav * feat: update examples * fix: build scripts * feat: update components * feat: restyle * fix: types * fix: styles * fix: margins * fix: screenshots * fix * feat: update theme * fix: charts nav * fix: image * feat: optimize images * fix: menu * fix: card * fix: border * check * feat: implement charts page * fix: charts * fix: og images * feat: extend touch * fix: static * fix: sizing * fix: mobile screenshots * fix: page nav * fix * feat: update favicon * fix: theme selector * fix: feedback * fix: sink * docs: update * fix: styles * chore: update registry * fix: command * fix * fix: minor updates * fix: typography on smaller devices * fix: format * fix: remove unused icon * feat: update favicon * fix: typography * docs: typography page * fix: steps
41 lines
1.5 KiB
Plaintext
41 lines
1.5 KiB
Plaintext
---
|
|
title: Registry
|
|
description: Run your own component registry.
|
|
---
|
|
|
|
<Callout>
|
|
**Note:** This feature is currently experimental. Help us improve it by
|
|
testing it out and sending feedback. If you have any questions, please [reach
|
|
out to us](https://github.com/shadcn-ui/ui/discussions).
|
|
</Callout>
|
|
|
|
You can use the `shadcn` CLI to run your own component registry. Running your own registry allows you to distribute your custom components, hooks, pages, and other files to any React project.
|
|
|
|
<figure className="flex flex-col gap-4">
|
|
<Image
|
|
src="/images/registry-light.png"
|
|
width="1432"
|
|
height="960"
|
|
alt="Registry"
|
|
className="mt-6 w-full overflow-hidden rounded-lg border dark:hidden"
|
|
/>
|
|
<Image
|
|
src="/images/registry-dark.png"
|
|
width="1432"
|
|
height="960"
|
|
alt="Registry"
|
|
className="mt-6 hidden w-full overflow-hidden rounded-lg border shadow-sm dark:block"
|
|
/>
|
|
<figcaption className="text-center text-sm text-gray-500">
|
|
Distribute code to any React project.
|
|
</figcaption>
|
|
</figure>
|
|
|
|
Registry items are automatically compatible with the `shadcn` CLI and `Open in v0`.
|
|
|
|
## Requirements
|
|
|
|
You are free to design and host your custom registry as you see fit. The only requirement is that your registry items must be valid JSON files that conform to the [registry-item schema specification](/docs/registry/registry-item-json).
|
|
|
|
If you'd like to see an example of a registry, we have a [template project](https://github.com/shadcn-ui/registry-template) for you to use as a starting point.
|