xyd

xyd es un marco de documentación que te permite crear sitios web de documentación profesionales sin lidiar con herramientas complejas. Viene con seis hermosos temas integrados que puedes usar de inmediato, o puedes personalizar cada parte para que coincida con tu marca. El marco genera automáticamente documentación a partir de tus especificaciones de código OpenAPI, GraphQL, TypeScript y React.

A diferencia de otras herramientas de documentación, xyd incluye todo lo que necesitas desde el principio. Obtienes búsqueda de texto completo con sugerencias inteligentes, análisis integrados para rastrear cómo las personas usan tu documentación, integración de chat en vivo e incluso capacidades de pruebas A/B. El servidor de desarrollo se inicia al instante con recarga en caliente, para que veas los cambios de inmediato. Creado por desarrolladores para desarrolladores, xyd elimina las partes aburridas de crear documentación para que puedas concentrarte en escribir contenido excelente.

Comenzar con xyd es sencillo. Aquí están los pasos para crear tu documentación:

• Instala xyd globalmente usando el comando bun add -g xyd-js o tu gestor de paquetes preferido. Necesitarás tener Node.js versión 22.12 o superior instalado en tu computadora.

• Ejecuta xyd en la carpeta de tu proyecto para iniciar el servidor de desarrollo. Se lanza al instante con recarga en caliente, lo que significa que puedes ver tus cambios aparecer inmediatamente sin reiniciar.

• Elige entre seis temas integrados o crea tu propio diseño personalizado. Cada tema ofrece un estilo y diseño diferente para adaptarse a las necesidades de tu proyecto.

• Escribe tu documentación usando el marco de contenido enriquecido que soporta componentes interactivos, ejemplos de código en vivo y elementos dinámicos que hacen que tus documentos sean más atractivos.

• Para documentación de API, simplemente apunta xyd a tus especificaciones OpenAPI, GraphQL, TypeScript o React y genera documentación hermosa automáticamente.

• Ejecuta xyd build cuando estés listo para crear archivos estáticos para desplegar en cualquier servicio de hosting.

• Seis hermosos temas integrados disponibles

• Documentación automática de API desde OpenAPI, GraphQL, TypeScript, React

• Servidor de desarrollo con recarga en caliente y sin configuración

• Personalización completa de todos los componentes y diseños

• Amplio ecosistema de plugins para búsqueda, análisis, chat

• Ejemplos de código interactivos y contenido dinámico

• Soporte integrado para análisis y pruebas A/B

• Funcionalidad de búsqueda de texto completo ultrarrápida

• De código abierto y completamente gratuito

• Herramientas de migración desde otros frameworks