> ## Documentation Index
> Fetch the complete documentation index at: https://docs.widerouter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AGENTS

# Repository Guidelines

完整规范见 `CLAUDE.md`。以下是最容易踩的几条：

## 目录职责

* **仓库根目录 = 英文源语言**，`zh/` = 人工中文
* `zh-Hant/` `ja/` `ko/` `ru/` = **构建产物，绝不手工编辑**
* `scripts/` `test/` `data/` 不参与站点构建（见 `.mintignore`）

## 硬规则（pre-commit 会拦）

* 正文不写 H1，从 `##` 起（Mintlify 用 frontmatter 的 `title` 自动生成 H1）
* 正文 `$` 要转义成 `\$`；**frontmatter 里反过来**，直接写 `$`
* 标题里用全角 `％`，半角 `%` 会导致 Mintlify SSR 500
* JSX 属性值里不能再出现 ASCII 双引号，中文用「」
* 品牌名统一 `WideRouter`
* 新页面必须英中双语同步产出，并同时注册进 `docs.json` 的 `en` / `zh` 两块
* 真实 API Key 一律从环境变量读，占位符写成 `sk-your-api-key`

## 常用命令

```bash theme={null}
npm run hooks:install   # 每个克隆执行一次
npm run check           # 文档规范
npm run secrets         # Key 扫描
npm run links           # 坏链
npm run i18n            # 生成繁日韩俄（先 npm run i18n:plan 看规模）
npx mintlify dev        # 本地预览
```