Repolode
提交项目
livesession

livesession/xyd

基于 TypeScript 的文档框架，可从 Markdown/MDX 生成文档站点，并支持 OpenAPI 与 GraphQL 接口文档。

可替代:Readme.comGitBook

在 GitHub 查看官网
Star
115
Fork
9
未关闭 Issue
36
最近提交
9天前

这是什么？

xyd 是一个基于 TypeScript 和 React 构建的文档框架，可将 Markdown 和 MDX 内容生成为文档网站。它提供无需配置、支持热更新的开发服务器，并可通过命令构建静态文件用于部署。

其特色是原生支持 API 规范：可根据 OpenAPI 和 GraphQL 模式生成接口文档，并基于这些规范生成 SDK。项目内置多款主题、全文搜索，并集成了数据分析、A/B 测试和在线客服等插件，组件也可自由扩展或替换。

项目采用 MIT 许可证，需要 Node 22.12 及以上版本。另外提供迁移工具，方便从其他文档框架迁移过来。

核心功能

  • 01基于 Markdown 和 MDX 内容生成文档
  • 02根据 OpenAPI 和 GraphQL 规范生成接口参考页面
  • 03支持基于 API 规范生成 SDK
  • 04内置多款主题和全文搜索
  • 05集成数据分析、A/B 测试和在线聊天等插件
  • 06组件与布局可自定义

适用场景

  • 为 Web 应用发布产品文档
  • 通过自动生成的参考页面为 REST 或 GraphQL 接口编写文档
  • 搭建同时提供 SDK 与接口文档的开发者门户
  • 将已有文档站点从其他框架迁移过来

快速上手

  1. 1

    确认已安装 Node 22.12+

  2. 2

    使用 bun 全局安装 xyd

    bun add -g xyd-js
  3. 3

    启动开发服务器

    xyd
  4. 4

    构建静态文档文件

    xyd build

使用前须知

  • 需要 Node 22.12 或更高版本。

收录于专题

GraphQL 接口与 API 客户端静态网站生成器与文档工具

标签

#docs#documentation#markdown#mdx#openapi#graphql#api-docs#react#api-explorer#docs-generator

常见问题

xyd 是什么？
基于 TypeScript 的文档框架，可从 Markdown/MDX 生成文档站点，并支持 OpenAPI 与 GraphQL 接口文档。 xyd 是一个基于 TypeScript 和 React 构建的文档框架，可将 Markdown 和 MDX 内容生成为文档网站。它提供无需配置、支持热更新的开发服务器，并可通过命令构建静态文件用于部署。
xyd 可以免费使用吗？用的什么许可证？
xyd 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
xyd 还在维护吗？
活跃维护中。xyd 最近一次提交是在 2026年10月29日。
xyd 适合用来做什么？
为 Web 应用发布产品文档 通过自动生成的参考页面为 REST 或 GraphQL 接口编写文档 搭建同时提供 SDK 与接口文档的开发者门户 将已有文档站点从其他框架迁移过来
xyd 怎么安装和运行？
确认已安装 Node 22.12+ 使用 bun 全局安装 xyd: bun add -g xyd-js 启动开发服务器: xyd 构建静态文档文件: xyd build
在哪里获取 xyd？
源代码和安装说明在 GitHub 上：https://github.com/livesession/xyd

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目