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

# Cookbook

## 主要功能

* **直接使用现有文档。** 从仓库读取 Markdown、MDX 和本地资源，或使用已锁定版本和完整性校验值的 npm 包构建站点。[内容来源](/content-sources/)。
* **生成 API 参考。** 将本地 OpenAPI 规范转换为可搜索的概览和每个操作的独立页面，展示参数、请求体、响应和示例。[OpenAPI 参考](/content-sources/#openapi-references)。
* **内置搜索。** Pagefind 在本地为页面和标题建立索引，支持键盘快捷键，搜索资源按需加载。[搜索](/site-navigation/#search)。
* **适应文档增长的导航。** 使用标签页和分组侧边栏组织章节，提供页内目录、上一页和下一页链接，以及移动端抽屉导航。[搜索与导航](/site-navigation/)。
* **技术写作组件。** 在 MDX 中使用标签页、提示框、卡片、步骤、代码组、带复制功能的代码高亮，以及隔离运行的交互预览。[内容编写组件](/authoring/)。
* **契合产品的主题。** 通过 [Tasty](https://tasty.style) 和 [Glaze](https://glaze.tenphi.me) 配置品牌颜色、语义色板、字体、排版和组件的各个部分。浅色、深色和高对比度模式都使用构建时生成的静态 CSS。[主题与组件](/theme-and-components/)。
* **语言与版本。** 提供翻译页面和不同版本的文档；切换时，如果存在对应页面，就会直接打开该页面。[语言与版本](/site-navigation/#contents-languages-and-versions)。
* **发布前检查。** 检测无效链接、缺失资源、重复路由和错误的导航配置，并指出源文件位置。将预渲染 HTML 部署到任意静态托管服务。[质量检查](/quality-checks/)。
* **便于分享和读取的页面。** 发布规范网址、社交预览、站点地图、可下载的 Markdown，以及供编程智能体使用的 `llms.txt` 索引。[发布元数据](/publishing/)。

## 从你的仓库开始

在已有 `README.md` 或 `docs/` 目录的项目中运行：

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

Cookbook 会直接读取原位置的文件。你也可以[创建新站点](/zh/getting-started/)、[为实际发布到 npm 的文件编写文档](/zh/getting-started/)，或[将 Cookbook 加入现有 Astro 项目](/zh/getting-started/)。

## 本站就是一个示例

你正在阅读的页面来自 [docs/zh/index.md](https://github.com/tenphi/cookbook/blob/main/docs/zh/index.md)。一个小型 [Astro 应用](https://github.com/tenphi/cookbook/tree/main/apps/reference) 直接从仓库根目录的 `docs/` 构建站点。导航、搜索、代码操作、编辑链接和 Git 更新时间都可用于任何 Cookbook 站点。

## 浏览指南

* [入门](/zh/getting-started/)：仓库、npm 包和现有 Astro 项目的使用方法。
* [文档工具对比](/comparison/)：Cookbook 的内容与自定义方式。
* [示例](/examples/)：仓库、单体仓库、软件包和共享主题配置。
* [搜索与导航](/site-navigation/)：读者如何找到页面。
* [内容编写](/authoring/)：页面、组件和交互示例。
* [主题与组件](/theme-and-components/)：品牌、设计标记、字体、内置样式和自定义组件。
* [部署](/deployment/)：验证与静态托管。

其他文档目前仍以英文提供。另请参阅 [AI 智能体工作流程](/ai-agents/)、[配置参考](/configuration/)、[发布选项](/publishing/)和 [CLI 参考](/cli/)。