mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-07-02 17:08:39 +00:00
9643db42cf
* chore: 2.2.0-canary.2 * feat: add docs for registry * docs(www): update registry docs * fix: update dep * docs(www): update docs * docs(www): update registry docs * feat: add new label * fix: lint
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="border dark:hidden shadow-sm rounded-lg overflow-hidden mt-6 w-full"
|
|
/>
|
|
<Image
|
|
src="/images/registry-dark.png"
|
|
width="1432"
|
|
height="960"
|
|
alt="Registry"
|
|
className="border hidden dark:block shadow-sm rounded-lg overflow-hidden mt-6 w-full"
|
|
/>
|
|
<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.
|