Repolode
Enviar
livesession

livesession/xyd

Framework de documentación en TypeScript que crea sitios a partir de Markdown/MDX y genera documentación de API para OpenAPI y GraphQL.

Alternativa open source a:Readme.comGitBook

Ver en GitHubSitio web
Estrellas
115
Forks
9
Issues abiertos
36
Último commit
hace 9 días

¿Qué es?

xyd es un framework de documentación desarrollado con TypeScript y React. Convierte contenido Markdown y MDX en un sitio de documentación e incluye un servidor de desarrollo con recarga en caliente que funciona sin configuración, además de un comando para generar archivos estáticos listos para el despliegue.

Su característica distintiva es la compatibilidad nativa con especificaciones de API. Genera documentación a partir de esquemas OpenAPI y GraphQL y permite generar SDK a partir de esas especificaciones. También incluye temas integrados, búsqueda de texto completo e integraciones para analítica, pruebas A/B y chat en vivo. Además, sus componentes se pueden ampliar o reemplazar.

El proyecto cuenta con licencia MIT y requiere Node 22.12 o posterior. Incluye una herramienta de migración para pasar desde otros frameworks de documentación.

Funciones clave

  • 01Genera documentación a partir de contenido Markdown y MDX
  • 02Crea páginas de referencia de API a partir de especificaciones OpenAPI y GraphQL
  • 03Permite generar SDK a partir de especificaciones de API
  • 04Incluye temas integrados y búsqueda de texto completo
  • 05Ofrece integraciones para analítica, pruebas A/B y chat en vivo
  • 06Permite personalizar los componentes y los diseños

Casos de uso

  • Publicar documentación de producto para una aplicación web
  • Documentar una API REST o GraphQL con páginas de referencia generadas automáticamente
  • Crear un portal para desarrolladores que incluya SDK junto con la documentación de la API
  • Migrar un sitio de documentación existente desde otro framework

Inicio rápido

  1. 1

    Confirma que Node 22.12 o una versión posterior esté instalado

  2. 2

    Instala xyd globalmente con bun

    bun add -g xyd-js
  3. 3

    Inicia un servidor de desarrollo

    xyd
  4. 4

    Genera los archivos estáticos de la documentación

    xyd build

Antes de usarlo

  • Se requiere Node 22.12 o una versión posterior.

En colecciones

APIs GraphQL y clientes de APIGeneradores de sitios estáticos y herramientas de documentación

Temas

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

Preguntas frecuentes

¿Qué es xyd?
Framework de documentación en TypeScript que crea sitios a partir de Markdown/MDX y genera documentación de API para OpenAPI y GraphQL. xyd es un framework de documentación desarrollado con TypeScript y React. Convierte contenido Markdown y MDX en un sitio de documentación e incluye un servidor de desarrollo con recarga en caliente que funciona sin configuración, además de un comando para generar archivos estáticos listos para el despliegue.
¿xyd es gratuito? ¿Qué licencia tiene?
xyd es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿xyd sigue mantenido?
Mantenimiento activo. El último commit de xyd fue el 29 oct 2026.
¿Para qué puedo usar xyd?
Publicar documentación de producto para una aplicación web Documentar una API REST o GraphQL con páginas de referencia generadas automáticamente Crear un portal para desarrolladores que incluya SDK junto con la documentación de la API Migrar un sitio de documentación existente desde otro framework
¿Cómo se instala xyd?
Confirma que Node 22.12 o una versión posterior esté instalado Instala xyd globalmente con bun: bun add -g xyd-js Inicia un servidor de desarrollo: xyd Genera los archivos estáticos de la documentación: xyd build
¿Dónde consigo xyd?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/livesession/xyd

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados