# PzzaDocs

> A customizable MDX docs framework for Next.js.

- [Overview](https://docs.pzza.works/index.mdx): A customizable MDX docs framework for Next.js.

## Getting Started

Install the package and mount the routes.

- [Installation](https://docs.pzza.works/getting-started/installation.mdx): Add PzzaDocs to a Next.js 16 app and mount the docs routes.
- [Project Structure](https://docs.pzza.works/getting-started/project-structure.mdx): Where files live in a PzzaDocs project and what each one is responsible for.

## Guides

Configuration, content, and customization.

- [Configuration](https://docs.pzza.works/guides/configuration.mdx): Every field of the docs.config.ts file and what it controls.
- [Writing Content](https://docs.pzza.works/guides/content.mdx): Frontmatter, the full meta.json grammar, route groups, locales, and heading controls.
- [Localization](https://docs.pzza.works/guides/i18n.mdx): Translated content with the suffix or directory strategy, locale prefixes in URLs, locale-aware routes, and translated UI strings.
- [Sidebar](https://docs.pzza.works/guides/sidebar.mdx): Root folders, versioned docs, default open levels, prefetching, and icons.
- [Search](https://docs.pzza.works/guides/search.mdx): The structured search index, record types, keyboard shortcuts, and the search config.
- [LLM Outputs](https://docs.pzza.works/guides/llm.mdx): llms.txt, llms-full.txt, per-page Markdown, the page actions menu, and the llm config.
- [Theming](https://docs.pzza.works/guides/theming.mdx): Restyle PzzaDocs from one config object, from global CSS tokens, or from the stable class names.
- [Presets](https://docs.pzza.works/guides/presets.mdx): Nine built-in palettes for light and dark, a picker for trying them live, and how to extend one with your own colours.
- [CSS overrides](https://docs.pzza.works/guides/css-overrides.mdx): Cascade layers, token overrides in globals.css, and the stable class names and state attributes you can target.
- [Dark mode](https://docs.pzza.works/guides/dark-mode.mdx): How the light and dark themes switch, the D hotkey, forcing a scheme, and native control colours.

## Components

Everything available inside MDX without imports.

- [Callout](https://docs.pzza.works/components/callout.mdx): Highlight a note, warning, or error inline with the content.
- [Tabs](https://docs.pzza.works/components/tabs.mdx): Show alternative versions of the same content, such as package manager commands.
- [Steps](https://docs.pzza.works/components/steps.mdx): Present a numbered sequence of instructions with a connecting line.
- [Accordion](https://docs.pzza.works/components/accordion.mdx): Collapsible sections for FAQs and optional detail.
- [Type Table](https://docs.pzza.works/components/type-table.mdx): A props or options reference table with name, type, default, and description.
- [Code Blocks](https://docs.pzza.works/components/code-blocks.mdx): Fence meta, tabs, line numbers, notation transformers, package-install, and the monochrome themes.
- [Files](https://docs.pzza.works/components/files.mdx): Render a file tree with collapsible folders.
- [Cards](https://docs.pzza.works/components/cards.mdx): Link grids for landing pages, overviews, and "next steps" sections.
- [Inline TOC](https://docs.pzza.works/components/inline-toc.mdx): A collapsible table of contents rendered inside the article.
- [Image Zoom](https://docs.pzza.works/components/image-zoom.mdx): Click any image to open it in a lightbox.
- [Banner](https://docs.pzza.works/components/banner.mdx): A dismissible announcement bar above the header.
- [Mermaid](https://docs.pzza.works/components/mermaid.mdx): Flowcharts, sequence diagrams, and every other Mermaid diagram type from a fenced code block.
- [Math](https://docs.pzza.works/components/math.mdx): TeX formulas rendered with KaTeX, inline and as display blocks.

## API Reference

Config and source reference.

- [Config](https://docs.pzza.works/api/config.mdx): Full reference for defineConfig, DocsConfig, and ResolvedDocsConfig.
- [Theme](https://docs.pzza.works/api/theme.mdx): Full reference for ThemeConfig, the colour and code token types, the design tokens, ThemeStyles and resolveThemeCss.
- [Source](https://docs.pzza.works/api/source.mdx): Reference for createSource, every Source method, the page and tree types, and the tree helpers.