Introduction
Getting started with core library
What is this?
Hanzo Docs Core offers server-side functions and headless components to build docs on any React.js frameworks like Next.js.
- Search (built-in: Orama, Algolia Search)
- Breadcrumb, Sidebar, TOC Components
- Remark/Rehype Plugins
- Additional utilities
Tip
It can be used without Hanzo Docs UI, in other words, it's headless.
For beginners and normal usages, use Hanzo Docs UI.
Installation
No other dependencies required.
npm install @hanzo/docs-coreFor some components, a framework provider is needed:
import type { ReactNode } from 'react';
import { NextProvider } from '@hanzo/docs/core/framework/next';
export function RootLayout({ children }: { children: ReactNode }) {
// or if you're using Hanzo Docs UI, use `<RootProvider />`
return <NextProvider>{children}</NextProvider>;
}It offers simple document searching as well as components for building a good docs.
How is this guide?
Last updated on