Documentación que permanece junto al código
Cookbook es un kit de herramientas de documentación para Astro. Convierte el Markdown de tu repositorio o un paquete npm publicado en un sitio estático con búsqueda, y adapta los colores, la tipografía y los componentes a tu producto.
- Usa la documentación que ya tienes. Lee Markdown, MDX y recursos locales directamente desde tu repositorio, o genera el sitio a partir de un paquete npm fijado por versión e integridad. Fuentes de contenido.
- Genera una referencia de API. Convierte una especificación OpenAPI local en un resumen con búsqueda y una página por operación, con parámetros, cuerpos de petición, respuestas y ejemplos. Referencias OpenAPI.
- Búsqueda integrada. Pagefind indexa las páginas y los encabezados localmente, con un atajo de teclado y recursos de búsqueda que se cargan cuando hacen falta. Búsqueda.
- Navegación para documentación que crece. Organiza secciones con pestañas y barras laterales agrupadas, añade índices de página y enlaces anterior/siguiente, y ofrece un menú de navegación móvil. Búsqueda y navegación.
- Componentes para documentación técnica. Usa pestañas, avisos, tarjetas, pasos, grupos de código, código resaltado con controles de copia y ejemplos interactivos aislados en MDX. Componentes de contenido.
- Un tema adaptado a tu producto. Configura colores de marca, paletas semánticas, fuentes, tipografía y partes de componentes con Tasty y Glaze. Los modos claro, oscuro y de alto contraste reciben CSS estático generado durante la compilación. Tema y componentes.
- Idiomas y versiones. Ofrece páginas traducidas y documentación versionada, con selectores que llevan a la página equivalente cuando existe. Idiomas y versiones.
- Comprobaciones antes de publicar. Detecta enlaces rotos, recursos ausentes, rutas duplicadas y navegación inválida con errores que señalan el archivo de origen. Publica HTML prerenderizado en cualquier alojamiento estático. Comprobaciones de calidad.
- Páginas listas para compartir y leer. Publica URL canónicas, vistas previas para redes sociales, mapas del sitio, Markdown descargable y un índice
llms.txtpara agentes de programación. Metadatos de publicación.
Ejecuta estos comandos en un proyecto que ya tenga un archivo README.md o un directorio docs/:
npm create @tenphi/cookbook@latest docs-site -- --source . --yes
cd docs-site
npm run devCookbook lee los archivos donde ya están. También puedes crear un sitio nuevo, documentar exactamente los archivos publicados en npm o añadir Cookbook a un proyecto Astro.
Esta página procede de docs/es/index.md. Una pequeña aplicación Astro genera el sitio directamente desde el directorio docs/ del repositorio. La navegación, la búsqueda, los controles de código, los enlaces de edición y las fechas de Git están disponibles para cualquier sitio Cookbook.
- Primeros pasos explica cómo empezar con repositorios, paquetes npm y proyectos Astro existentes.
- Comparación de herramientas describe el modelo de contenido y personalización de Cookbook.
- Ejemplos muestran configuraciones para repositorios, monorepos, paquetes y temas compartidos.
- Búsqueda y navegación explica cómo encuentran los lectores las páginas.
- Redacción cubre páginas, componentes y ejemplos interactivos.
- Tema y componentes introduce la marca y los tokens y enlaza con fuentes, estilos y componentes propios.
- Despliegue cubre la validación y el alojamiento estático.
El resto de la documentación aún está disponible en inglés. Consulta también el flujo para agentes de IA, la referencia de configuración, las opciones de publicación y la referencia de la CLI.