Skip to content

README.md

Latest commit

 

History

History
78 lines (51 loc) · 1.75 KB

README.md

File metadata and controls

78 lines (51 loc) · 1.75 KB
Raw

Tailark Registry

Open source shadcn/ui registry for Tailark blocks and pages.

Endpoints

The registry ships two bases: Base UI (base) and Radix UI (radix). Base UI is the default, so it is served under /r without a base segment.

Base UI (default):

  • /r/registry.json returns the full Base UI registry index.
  • /r/[name] returns a single Base UI registry item with file contents.

Radix UI:

  • /r/radix/registry.json returns the full Radix UI registry index.
  • /r/radix/[name] returns a single Radix UI registry item with file contents.

Registry namespace

Consumers install items through shadcn registry namespace. Add the @tailark-oss namespace to your project's components.json. Base UI is the default namespace, and Radix UI is available under a dedicated one:

Default (Base UI)

{
  "registries": {
    "@tailark-oss": "https://oss-tailark.com/r/{name}",
  }
}

Radix UI

{
  "registries": {
    "@tailark-oss": "https://oss-tailark.com/r/radix/{name}",
  }
}

Then install any block or page by name:

# Base UI (default)
npx shadcn@latest add @tailark-oss/dusk-hero-section-one

Browse available item names at `/r/registry.json` (Base UI) or `/r/radix/registry.json` (Radix UI).

Development

pnpm install
pnpm dev

Open http://localhost:3003/registry to inspect the registry index.

Start Using

Visit Tailark to start using Tailark.

Contributing

Learn more about Contributing.

License

Tailark is released under the MIT License.



Vercel OSS Program