用途:帮助用户从零搭建并管理自定义 shadcn/ui 组件注册表(registry),包括脚手架、编写组件、生成 JSON 产物,并指导托管与部署。
主要能力:
- 项目初始化:可用官方模板 npx degit shadcn-ui/registry-template my-registry,或在已有项目安装 shadcn CLI 并添加 registry:build 脚本。
- 目录规范:源码放在 registry/ 下,构建产物输出到 public/r/,导入使用 @/registry/... 路径。
- 清单与类型:registry.json 定义 name、homepage、items;条目类型含 registry:ui、registry:block、registry:component、registry:hook、registry:lib、registry:page、registry:theme、registry:style、registry:item、registry:file。
- 构建:npx shadcn build,支持自定义输入、--output 与 --watch。
- 安装与分发:用户通过 npx shadcn@latest add https://your-domain.com/r/component-name.json 安装;支持命名空间(@acme/name)与私有注册表认证(Bearer、API Key、Basic、查询参数)。
- 部署:可部署到 Vercel、Netlify、GitHub Pages 或任意静态托管,需返回 application/json 并配置 CORS。
使用方式:按步骤搭建项目、编写组件、维护 registry.json、执行构建、本地测试安装,再部署并更新 homepage。
适用场景:团队内部组件库、品牌主题、可复用 UI 块与页面模板的分发。
限制:部署、推送到 GitHub、提交官方索引等需用户手动完成;public/r/ 为自动生成不可手改;envVars 不会覆盖已有值,仅用于开发示例变量;官方索引收录要求开源、公开可访问且符合 schema。