记录 API

Lynx 文档依赖于一个结构化系统，以确保 API 参考准确且一致。

兼容性数据 (`lynx-compat-data`)

平台兼容性的真实来源存储在 packages/lynx-compat-data 中。这是一个类似于 MDN browser-compat-data 的 JSON 数据库。

添加新 API

导航至 packages/lynx-compat-data。
找到合适的 JSON 文件（例如 lynx-api/global/console/log.json）。
按照模式添加您的 API 定义。

显示 API 表格

要在文档中显示兼容性表格，请使用 <APITable> 组件。

使用 Frontmatter（推荐）

推荐在 Frontmatter 中定义 api 字段。

---
api: lynx-api/global/console/log
---

然后在 MDX 文件中放置 <APITable />。它会自动读取 api 字段。

<APITable />

多个表格（显式查询）

当您需要在一个页面上显示多个表格时，可以显式传递 query 属性。

例如，在 fetch 中，Headers、Request 和 Response 使用了单独的表格：

### Headers

<APITable query="lynx-api/fetch/Headers" />

### Request

<APITable query="lynx-api/fetch/Request" />

LCD tables only load in the browser

您可以使用下方的交互式浏览器验证有效的查询。

API 摘要

要获取 API 组（如方法、属性、事件）的高级视图，请使用 <APISummary>。与 <APITable> 类似，它默认从 api Frontmatter 字段读取。

<APISummary />

交互式浏览器

您可以使用下面的浏览器查找有效的 API 查询并预览其表格。

兼容性探索器

搜索 Lynx 特性和 API，查看其跨平台兼容性

快速访问：

将此表格嵌入到您的 MDX 中：

import { APISummary, APITable } from '@lynx';

<APISummary query="css/properties/gap" />
<APITable query="css/properties/gap" />

LCD tables only load in the browser

验证文档

CI 会对所有已跟踪的 API 页面执行兼容性组件查询校验。该全量检查有意不接入 lint-staged。如需在本地运行同一检查：

pnpm run check:api-summary

该检查会验证：

<APISummary> 是否指向包含直接兼容性记录的标识符。
<APITable> 是否指向包含直接兼容性记录的标识符。
包含表格的 API 页面是否至少包含一个有效摘要；当页面记录相关条目时，两者可以使用不同查询。
静态组件查询（包括 MDX 表达式中的 JSX）与 api Frontmatter 是否引用了现有数据。
查询是否不包含空的 / 或 . 路径段。

Warning

旧版 check-docs 和 fix-docs 命令未在 CI 中运行，且目前不建议使用。尤其是 fix-docs，它可能重写大量 MDX 文件（包括生成的 *-API.mdx 页面），并造成破坏性的格式化变更。详见 #896。

生成的 API 参考

lynx-stack 各包的 API 参考（api/config、api/react、api/genui 和 api/packages）在 lynx-stack 中根据源码的 TSDoc 注释生成，pnpm install 时从 @lynx-js/lynx-stack-docs 复制到本站。这些页面不提交到本仓库；如需修改，请编辑 lynx-stack 中的源码注释。

#记录 API

#兼容性数据 (lynx-compat-data)

#添加新 API

#显示 API 表格

#使用 Frontmatter（推荐）

#多个表格（显式查询）

#API 摘要

#交互式浏览器

#验证文档

#生成的 API 参考