xyd

xyd 是一个文档框架，让您无需与复杂工具斗争即可创建专业的文档网站。它配备了六个漂亮的内置主题，您可以立即使用，或者自定义每个部分以匹配您的品牌。该框架会根据您的 OpenAPI、GraphQL、TypeScript 和 React 代码规范自动生成文档。

与其他文档工具不同，xyd 从一开始就包含了您所需的一切。您可以获得带有智能建议的全文搜索、内置分析功能以跟踪用户如何使用您的文档、实时聊天集成，甚至还有 A/B 测试功能。开发服务器即时启动并支持热重载，让您能立即看到更改效果。xyd 由开发者为开发者打造，去除了制作文档中枯燥的部分，让您专注于撰写优质内容。

开始使用 xyd 非常简单。以下是创建文档的步骤：

• 使用命令 bun add -g xyd-js 或您喜欢的包管理器全局安装 xyd。您的电脑需要安装 Node.js 版本 22.12 或更高。

• 在您的项目文件夹中运行 xyd 启动开发服务器。它会即时启动并支持热重载，意味着您可以立即看到更改效果，无需重启。

• 从六个内置主题中选择，或创建您自己的自定义设计。每个主题都提供不同的风格和布局，以满足您的项目需求。

• 使用支持交互组件、实时代码示例和动态元素的丰富内容框架编写文档，使您的文档更具吸引力。

• 对于 API 文档，只需将 xyd 指向您的 OpenAPI、GraphQL、TypeScript 或 React 规范，它会自动生成精美的文档。

• 准备好后运行 xyd build，生成用于部署到任何托管服务的静态文件。

• 提供六种精美的内置主题

• 自动生成来自 OpenAPI、GraphQL、TypeScript、React 的 API 文档

• 零配置的热重载开发服务器

• 所有组件和布局的完全自定义

• 丰富的插件生态系统，支持搜索、分析、聊天

• 交互式代码示例和动态内容

• 内置分析和 A/B 测试支持

• 极速全文搜索功能

• 开源且完全免费

• 支持从其他框架的迁移工具