Documentation that stays with the code
- 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.
- 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.
- Search built in. Pagefind indexes your pages and headings locally, with a keyboard shortcut and search assets that load when needed. 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.
- Components for technical writing. Use tabs, callouts, cards, steps, code groups, highlighted code with copy controls, and sandboxed interactive previews in MDX. Authoring components.
- A theme that fits your product. Configure brand colors, semantic palettes, fonts, typography, and individual component parts through Tasty and Glaze. Light, dark, and high-contrast appearances receive static CSS generated at build time. 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.
- 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.
- Pages ready to share and read. Publish canonical URLs, social previews,
sitemaps, downloadable Markdown, and an
llms.txtindex for coding agents. Publishing metadata.
Run this from a project that already has a README.md or docs/ directory:
npm create @tenphi/cookbook@latest docs-site -- --source . --yes
cd docs-site
npm run devCookbook reads those files where they live. You can also start a new site, document the exact files published to npm, or add Cookbook to an Astro project.
The page you’re reading comes from this repository’s
docs/index.md.
A small Astro app
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.
- Getting started covers repositories, npm packages, and existing Astro projects.
- Compare documentation tools explains Cookbook’s content and customization model alongside other options.
- Working examples show repository, monorepo, package, and shared-theme configurations.
- Search and navigation explains how readers find pages.
- Authoring covers pages, components, and interactive examples.
- Theme and components starts with brand and tokens, then points to fonts, built-in styles, and custom components.
- Deployment covers validation and static hosting.
For agent-assisted setup, see the AI agent workflow. The configuration reference, publishing controls, and CLI reference cover the full set of options.