- apps
- OCX Catalog
OCX Catalog
@ocx-sh/catalog renders one or more OCX package indices into a browsable
static site: a package grid, per-package detail pages with README, platforms,
versions and install commands, client-side search, and an optional docs section.
It is a renderer, not a producer. Point it at an index — a local directory, an HTTPS endpoint, or a git repository — and it builds a site around what is already there. It never writes to an index and never invents index data. See Index vs. catalog for where that line sits.
Start from what you are trying to do
Section titled “Start from what you are trying to do”I run an index on GitHub and want a browsable catalog site.Render the CI workflow, build the site, deploy it to GitHub Pages, and the two things that will silently break if you use the default project Pages URL.
I run an index on GitLab and want a browsable catalog site.The rendered job file, the include: line your root .gitlab-ci.yml needs, and a pages job that publishes the build.
I want my catalog to also show the public index.ocx.sh packages.Aggregate the official index alongside your own as a second, non-root source. Every package from both stays listed, on its own detail page.
I want to self-host my own index: corporate mirror or air-gapped.A path or git source as your only source, with no dependency on index.ocx.sh and no build-time egress to it.
I just want to see it running before committing to anything.One command against a directory of index JSON, no config file, no deploy.
Install
Section titled “Install”npm install --save-dev @ocx-sh/catalogNode.js >=22.13. The package bundles its renderer, so there are no peer
dependencies to install. Then work through the Quickstart.
Upgrading from 0.5? Read Upgrade to 0.6 first.
The rest of the documentation
Section titled “The rest of the documentation”- How-To covers task-shaped guides: quickstart, sources, deploys, local preview and branding.
- Reference lists CLI flags and exit codes, the config schema, CI rendering and the output layout.
- Explanation covers why the design is the way it is: ownership, multi-source and the security model.
- Ops covers limitations, host selection and troubleshooting.