Doxygen genera documentación a partir de código fuente anotado y también puede crear diagramas de estructura y dependencias a partir de código sin documentar.
6,6 mil+6 esta semana1,4 milC++GPL-2.0Bien mantenidoActualizado hace 4 horas
realm/jazzy
Herramienta de línea de comandos que genera documentación de API en HTML con el estilo de Apple para proyectos de Swift y Objective-C.
- Estrellas
- 7,381
- Forks
- 413
- Issues abiertos
- 74
- Último commit
- el mes pasado
¿Qué es?
jazzy genera documentación de referencia de API para código Swift y Objective-C. En lugar de analizar directamente los archivos de código fuente, usa Clang y SourceKit para leer el AST del código junto con los comentarios de documentación, con el objetivo de generar resultados precisos. Las páginas generadas replican el aspecto de la documentación de referencia oficial de Apple.
La herramienta funciona en macOS y es compatible con proyectos de Xcode y Swift Package Manager. También puede generar documentación a partir de módulos Swift compilados mediante el grafo de símbolos, un método más rápido que leer el código fuente, pero que solo incluye declaraciones públicas. Se pueden combinar varios módulos en un mismo sitio con búsqueda y enlaces entre módulos; además, el contenido puede incluir guías en Markdown, fórmulas renderizadas con KaTeX y un docset de Dash.
La configuración se gestiona mediante un archivo `.jazzy.yaml` o flags de línea de comandos. Incluye tres temas integrados (apple, fullwidth, jony) y permite usar temas personalizados.
Funciones clave
- 01Genera documentación leyendo los AST de Clang y SourceKit, junto con los comentarios de documentación.
- 02Es compatible con proyectos de Xcode y Swift Package Manager, además de Objective-C.
- 03Puede generar documentación a partir de módulos Swift compilados mediante grafos de símbolos.
- 04Combina varios módulos en un mismo sitio con enlaces entre ellos.
- 05Renderiza fórmulas LaTeX con KaTeX e incluye guías en Markdown.
- 06Genera docsets de Dash y ofrece tres temas integrados.
Casos de uso
- Publicar documentación de referencia de API para un framework o SDK de Swift.
- Documentar una biblioteca de Objective-C con un encabezado umbrella.
- Generar un único sitio de documentación para una app y sus extensiones.
- Crear documentación sin conexión como docset de Dash.
Inicio rápido
- 1
Instala jazzy con RubyGems
[sudo] gem install jazzy - 2
Ejecuta jazzy desde la raíz de tu proyecto Swift
jazzy
Antes de usarlo
- Jazzy está pensado para ejecutarse en macOS; para usarlo en Linux, consulta los consejos adicionales del README.
En colecciones
Temas
Preguntas frecuentes
- ¿Qué es jazzy?
- Herramienta de línea de comandos que genera documentación de API en HTML con el estilo de Apple para proyectos de Swift y Objective-C. jazzy genera documentación de referencia de API para código Swift y Objective-C. En lugar de analizar directamente los archivos de código fuente, usa Clang y SourceKit para leer el AST del código junto con los comentarios de documentación, con el objetivo de generar resultados precisos. Las páginas generadas replican el aspecto de la documentación de referencia oficial de Apple.
- ¿jazzy es gratuito? ¿Qué licencia tiene?
- jazzy es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿jazzy sigue mantenido?
- Actualizado en los últimos 6 meses. El último commit de jazzy fue el 1 oct 2026.
- ¿Para qué puedo usar jazzy?
- Publicar documentación de referencia de API para un framework o SDK de Swift. Documentar una biblioteca de Objective-C con un encabezado umbrella. Generar un único sitio de documentación para una app y sus extensiones. Crear documentación sin conexión como docset de Dash.
- ¿Cómo se instala jazzy?
- Instala jazzy con RubyGems: [sudo] gem install jazzy Ejecuta jazzy desde la raíz de tu proyecto Swift: jazzy
- ¿Dónde consigo jazzy?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/realm/jazzy
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
Una extensión del editor de código fuente de Xcode que incorpora sugerencias de código, chat y modificación de código con GitHub Copilot, Codeium y ChatGPT.
8,2 mil428SwiftMITActualizado hace 14 días
Generador de documentación de API para JavaScript que crea documentación HTML a partir de comentarios con formato especial en el código fuente.
15,5 mil1,5 milJavaScriptApache-2.0Bien mantenidoActualizado hace 14 horas
Herramienta de línea de comandos que genera documentación de API en Markdown a partir de docstrings de Python con formato Google, como alternativa más ligera a Sphinx.
25342PythonMITActualizado hace 16 días
Framework de documentación en TypeScript que crea sitios a partir de Markdown/MDX y genera documentación de API para OpenAPI y GraphQL.
1159TypeScriptMITActualizado hace 9 días
Integración de GitHub Copilot para Xcode que añade completado de código, chat, modo agente y revisión de código para proyectos de Swift y Objective-C.
6,4 mil+9 esta semana2,1 milSwiftMITActualizado hace 5 días