Mount in React

OzzyRM ships a React docs UI. You can mount it in any React-based app that can:

1. Load an ozzyrm.config.ts (or pass a prebuilt catalog)
2. Render a client component (or a server wrapper that does)

Next.js App Router is a common host for OzzyRMDocsFromConfig, but it is not required. Vite, Remix, custom RSC setups, and plain React clients all work with the right entry.

Choose an entry

Minimal client mount

"use client";

import { OzzyRMDocs } from "ozzyrm/react";
import type { SchemaCatalogGroup } from "ozzyrm/ui";

export function SchemaDocsPage({
  catalog,
  defaultSchemaId,
}: {
  catalog: SchemaCatalogGroup[];
  defaultSchemaId?: string;
}) {
  return (
    <OzzyRMDocs
      catalog={catalog}
      defaultSchemaId={defaultSchemaId}
    />
  );
}

Load the catalog on the server (or in a loader) with loadCatalog, then pass it down as props.

Props shared by the UI

Glossary badges always open https://ozzyrm.vercel.app/docs/glossary/... in a new tab.

Next

• Client mount
• Server helper
• Watch & HMR
• Configuration