@gentleduck/docs

Shared docs app kit for building documentation sites.

Provides MDX rendering, page layouts, navigation, search, AI chat, theming, and Velite content pipeline -- everything needed to build a gentleduck docs app on Next.js.

Quick Start

bun add @gentleduck/docs

import { DocsProvider } from '@gentleduck/docs/client'
import { Mdx } from '@gentleduck/docs/client'

What it includes

• MDX components -- code blocks with syntax highlighting (Shiki), callouts, tabs, component previews, linked cards
• Page layouts -- site header/footer, sidebar navigation, table of contents, breadcrumbs, pager
• Search -- command menu with full-text search (Lunr)
• AI chat -- built-in chat panel
• Theming -- theme provider, mode toggle, color system, CSS variables
• Velite pipeline -- content schemas, rehype/remark plugins, MDX runtime
• Utilities -- event tracking, chart color helpers, date formatting

Entry points

| Entry point | Description | | --- | --- | | @gentleduck/docs | Types, config helpers, lib utilities (server-safe) | | @gentleduck/docs/client | React components, hooks, providers ('use client') | | @gentleduck/docs/velite | Velite content pipeline config | | @gentleduck/docs/styles/base.css | Base stylesheet | | @gentleduck/docs/styles/docs.css | Docs layout styles | | @gentleduck/docs/styles/mdx.css | MDX content styles |

License

MIT