Skip to content

Docs: GitHub Registry setup for direct installations #950

@Adityakishore0

Description

@Adityakishore0

Is your feature request related to a problem?

The previous implementation for GitHub Registry support in ScrollX UI was merged and partially documented, but the feature is still not fully complete from a documentation and developer experience standpoint.

While the core GitHub-based installation works, the registry configuration and documentation were not fully finalized before closure. Additional improvements were later pushed in the same branch.

Because of this, developers may still be unclear about:

  • How GitHub Registry installation differs from the existing @scrollxui namespace
  • Which installation method should be preferred
  • How to properly validate and use the new GitHub registry format

Describe the solution you'd like

Complete and stabilize the GitHub Registry support so that ScrollX UI works seamlessly with both:

  • The existing @scrollxui namespace registry (legacy and still supported)
  • The new GitHub-based registry system (shadcn-compatible format)

The goal is to ensure the GitHub registry setup is production-ready and clearly documented for developers.


Install commands (GitHub Registry)

# Install UI component directly from GitHub
npx shadcn@latest add Adityakishore0/ScrollX-UI/button

# Install block from GitHub registry
npx shadcn@latest add Adityakishore0/ScrollX-UI/not-found-with-glitchytext

Validation:

npx shadcn@latest registry validate Adityakishore0/ScrollX-UI

Note:

  • The existing @scrollxui namespace registry remains fully supported and unchanged.
  • GitHub Registry support is an additional installation method, not a replacement.
  • This issue focuses on completing documentation and improving developer clarity.

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions