React Router | Hanzo Docs

Getting Started

Before continuing, make sure to configure:

Tailwind CSS 4.
Hanzo Docs MDX: follow the Vite setup guide and create essential files like lib/source.ts.

Installation

npm

pnpm

yarn

bun

npm i @hanzo/docs

pnpm add @hanzo/docs

yarn add @hanzo/docs

bun add @hanzo/docs

Styles

Add the following to your Tailwind CSS file:

app/app.css

@import 'tailwindcss';
@import '@hanzo/docs/ui/css/neutral.css';
@import '@hanzo/docs/ui/css/preset.css';

Create Pages

Update your routes:

routes.ts

import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
  index('routes/home.tsx'),
  route('docs/*', 'docs/page.tsx'),
  route('api/search', 'docs/search.ts'),
] satisfies RouteConfig;

Create the following files:

app/lib/layout.shared.tsx

app/docs/page.tsx

app/docs/search.ts

import type { BaseLayoutProps } from '@hanzo/docs/ui/layouts/shared';

export function baseOptions(): BaseLayoutProps {
  return {
    nav: {
      title: 'React Router',
    },
  };
}

import type { Route } from './+types/page';
import { DocsLayout } from '@hanzo/docs-base-ui/layouts/docs';
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from '@hanzo/docs-base-ui/layouts/docs/page';
import { source } from '@/lib/source';
import defaultMdxComponents from '@hanzo/docs-base-ui/mdx';
import browserCollections from '@hanzo/docs-mdx:collections/browser';
import { baseOptions } from '@/lib/layout.shared';
import { useHanzoDocsLoader } from '@hanzo/docs-core/source/client';

export async function loader({ params }: Route.LoaderArgs) {
  const slugs = params['*'].split('/').filter((v) => v.length > 0);
  const page = source.getPage(slugs);
  if (!page) throw new Response('Not found', { status: 404 });

  return {
    path: page.path,
    pageTree: await source.serializePageTree(source.getPageTree()),
  };
}

const clientLoader = browserCollections.docs.createClientLoader({
  component(
    { toc, frontmatter, default: Mdx },
    // you can define props for the `<Content />` component
    props?: {
      className?: string;
    },
  ) {
    return (
      <DocsPage toc={toc} {...props}>
        <title>{frontmatter.title}</title>
        <meta name="description" content={frontmatter.description} />
        <DocsTitle>{frontmatter.title}</DocsTitle>
        <DocsDescription>{frontmatter.description}</DocsDescription>
        <DocsBody>
          <Mdx components={{ ...defaultMdxComponents }} />
        </DocsBody>
      </DocsPage>
    );
  },
});

export default function Page({ loaderData }: Route.ComponentProps) {
  const { path, pageTree } = useHanzoDocsLoader(loaderData);

  return (
    <DocsLayout {...baseOptions()} tree={pageTree}>
      {clientLoader.useContent(path)}
    </DocsLayout>
  );
}

import type { Route } from './+types/search';
import { createFromSource } from '@hanzo/docs/core/search/server';
import { source } from '@/lib/source';

const server = createFromSource(source, {
  // https://docs.orama.com/docs/orama-js/supported-languages
  language: 'english',
});

export async function loader({ request }: Route.LoaderArgs) {
  return server.GET(request);
}

Wrap your entire app under Hanzo Docs providers:

root.tsx

import { Links, Meta, Scripts, ScrollRestoration } from 'react-router';
import { RootProvider } from '@hanzo/docs/ui/provider/react-router';
import './app.css';

export function Layout({ children }: { children: React.ReactNode }) {
  return (
    <html lang="en" suppressHydrationWarning>
      <head>
        <meta charSet="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <Meta />
        <Links />
      </head>
      <body className="flex flex-col min-h-screen">
        <RootProvider>{children}</RootProvider>
        <ScrollRestoration />
        <Scripts />
      </body>
    </html>
  );
}

Done

You can start writing documents at content/docs:

content/docs/index.mdx

---
title: Hello World
---

I love Hanzo Docs