Hexta AIHexta AI

Introduction

Getting started with core library

What is this?

Hexta Core offers server-side functions and headless components to build docs on React.js frameworks like Next.js and Astro with React islands.

  • Search (built-in: Orama, Algolia Search)
  • Breadcrumb, Sidebar, TOC Components
  • Remark/Rehype Plugins
  • Additional utilities

Tip

It can be used without Hexta Docs, in other words, it's headless.

For beginners and normal usages, use Hexta Docs.

Installation

No other dependencies required.

npm install hexta-core

For some components, a framework provider is needed:

import type { ReactNode } from 'react';
import { NextProvider } from 'hexta-core/framework/next';

export function RootLayout({ children }: { children: ReactNode }) {
  // or if you're using Hexta Docs, use `<RootProvider />`
  return <NextProvider>{children}</NextProvider>;
}

It offers simple document searching as well as components for building a good docs.

How is this guide?