---
language: "en"
title: "Cookbook"
canonical: "https://cookbook.tenphi.me/"
source: "docs/index.md"
version: "0.28.0"
index: true
---

# Cookbook

## What you get

* **Use the docs you already have.** Read Markdown, MDX, and local assets
  directly from your repository, or build from an npm package locked to an exact
  version and integrity. [Content sources](/content-sources/).
* **Generate an API reference.** Turn a local OpenAPI spec into a searchable
  overview and a page for each operation, with parameters, request bodies,
  responses, and examples. [OpenAPI references](/content-sources/#openapi-references).
* **Search built in.** Pagefind indexes your pages and headings locally, with a
  keyboard shortcut and search assets that load when needed.
  [Search](/site-navigation/#search).
* **Navigation for growing docs.** Organize sections with tabs and grouped
  sidebars, add page contents and previous/next links, and give mobile readers a
  navigation drawer. [Search and navigation](/site-navigation/).
* **Components for technical writing.** Use tabs, callouts, cards, steps, code
  groups, highlighted code with copy controls, and sandboxed interactive
  previews in MDX. [Authoring components](/authoring/).
* **A theme that fits your product.** Configure brand colors, semantic palettes,
  fonts, typography, and individual component parts through [Tasty](https://tasty.style) and [Glaze](https://glaze.tenphi.me).
  Light, dark, and high-contrast appearances receive static CSS generated at
  build time. [Theme and components](/theme-and-components/).
* **Languages and versions.** Offer translated pages and versioned docs, with
  selectors that take readers to the equivalent page when available.
  [Languages and versions](/site-navigation/#contents-languages-and-versions).
* **Checks before you ship.** Catch broken links, missing assets, duplicate
  routes, and invalid navigation with errors that point to the source. Publish
  prerendered HTML to any static host. [Quality checks](/quality-checks/).
* **Pages ready to share and read.** Publish canonical URLs, social previews,
  sitemaps, downloadable Markdown, and an `llms.txt` index for coding agents.
  [Publishing metadata](/publishing/).

## Start with your repository

Run this from a project that already has a `README.md` or `docs/` directory:

```sh
npm create @tenphi/cookbook@latest docs-site -- --source . --yes
cd docs-site
npm run dev
```

Cookbook reads those files where they live. You can also
[start a new site](/getting-started/#create-your-first-site),
[document the exact files published to npm](/getting-started/#document-a-published-npm-package),
or [add Cookbook to an Astro project](/getting-started/#add-to-an-existing-astro-project).

## This site is the example

The page you're reading comes from this repository's
[docs/index.md](https://github.com/tenphi/cookbook/blob/main/docs/index.md).
A small [Astro app](https://github.com/tenphi/cookbook/tree/main/apps/reference)
builds directly from the root `docs/` directory. Its navigation, search, code
controls, edit links, and Git timestamps are available to every Cookbook site.
Use the language selector in the header to read this page and the getting-started
guide in Spanish, Russian, Japanese, or Simplified Chinese. Other guides remain
in English for now.

## Explore the guide

* [Getting started](/getting-started/) covers repositories, npm packages, and
  existing Astro projects.
* [Compare documentation tools](/comparison/) explains Cookbook's content and
  customization model alongside other options.
* [Working examples](/examples/) show repository, monorepo, package, and
  shared-theme configurations.
* [Search and navigation](/site-navigation/) explains how readers find pages.
* [Authoring](/authoring/) covers pages, components, and interactive examples.
* [Theme and components](/theme-and-components/) starts with brand and tokens,
  then points to fonts, built-in styles, and custom components.
* [Deployment](/deployment/) covers validation and static hosting.

For agent-assisted setup, see the [AI agent workflow](/ai-agents/). The
[configuration reference](/configuration/), [publishing controls](/publishing/),
and [CLI reference](/cli/) cover the full set of options.