Check out the New Node.js API Documentation Preview
TL;DR · AI 摘要
Node.js发布了全新API文档预览版，新增内置搜索、统一设计系统和AI工具入口等特性，提升开发者使用体验。
核心要点
- 新文档支持内置搜索功能，可通过页面上的搜索框直接访问
- 采用统一设计系统，与nodejs.org网站共享设计，提升跨设备可用性
- 引入llms.txt，为AI工具提供结构化的API参考入口
结构提纲
按章节快速跳转。
思维导图
用一张图看清主题之间的关系。
查看大纲文本（无障碍 / 无 JS 友好）
- Node.js API文档更新
- 核心功能
- 内置搜索
- 统一设计系统
- llms.txt
- 技术实现
- doc-kit工具
- 用户参与
- 反馈渠道
- 离线支持
金句 / Highlights
值得收藏与分享的关键句。
内置搜索功能首次出现在API文档中，支持键盘快捷键直接访问
新文档采用与nodejs.org统一的设计系统，包含持久侧边栏和自适应布局
llms.txt为AI工具提供结构化API入口，提升机器可读性
Node.js — 查看全新的 Node.js API 文档预览
查看全新的 Node.js API 文档预览
GAJ
Guilherme Araújo
查看全新的 Node.js API 文档预览
我们一直在重建 Node.js 生成和展示 API 文档的方式，目前预览版已在 beta.docs.nodejs.org 上线。在成为默认版本之前，我们希望尽可能多的人能实际使用它并告诉我们您的反馈意见。
对读者而言的变化
内容本身没有变化：每一页都是从 nodejs/node 仓库中相同的 Markdown 文件生成，这些文件也是当前文档的基础。您今天依赖的功能也一并迁移过来：浅色/深色主题、ESM/CJS 切换、代码片段的复制按钮、稳定性徽章、版本历史记录，以及每一页的 Markdown 版本。
尽管视觉层面的改版只是表面，但导航、布局和可读性都经过了全面重构，使查找和理解 API 变得更加轻松。此外，该预览版还新增了当前文档从未具备的功能：
- 搜索：首次引入内置搜索功能。每个页面都配有搜索框，并支持快捷键，让您无需通过搜索引擎即可直接跳转到 API 的任意位置。
- 统一设计语言：API 文档现在采用与 nodejs.org 网站相同的设计系统，包含持久侧边栏（列出所有模块）、每页始终可见的目录，以及适配小屏幕的布局。
- llms.txt：我们已上线 llms.txt，为 AI 工具提供了清晰、结构化的 API 参考入口。
这还不是全部：预览版还新增了阅读时间估算和公告栏等功能。
我们同样关注每一位用户的使用需求，尤其重视那些容易被忽视的场景。即使在 JavaScript 禁用或离线状态下，每一页内容依然保持可用。
技术实现
全新设计的文档基于 doc-kit 构建，这是 Node.js 项目开发的一款独立工具，用于取代之前的遗留文档生成器。
如需了解 doc-kit 的更多信息及其对其他项目的功能支持，请查阅其仓库。该仓库也将是提交 bug 报告、功能请求和其他任务的指定位置。
我们需要您的反馈
尽管我们自豪地宣布全新设计的文档已进入开发的最后阶段，但反馈仍然是此次迁移过程中至关重要的部分。我们非常期待听到您对这一过程的看法。请将您发现的任何问题（无论大小）以 issue 的形式提交到 nodejs/doc-kit 仓库。
致谢
如果没有 Node.js Web 团队的成员，这一切都不会实现。他们设计、构建并审核了本文所述的所有内容。同时也要感谢 Node.js 社区和那些一路以来通过审核、测试和提出建议的贡献者。感谢大家让这一切成为可能。
Next
由于资金流失，安全漏洞赏金计划暂时中止 /