Documentación de React, servida como HTML.
Ardo es un generador de sitios estáticos para proyectos React. Guías en Markdown y MDX, una referencia de la API extraída de tu TypeScript y búsqueda, todo prerenderizado con Rust durante la compilación.
← actualizado desde npm en cada compilación
tus carpetas se convierten en esta barra
resaltado durante la compilación
cómo funciona
Del repositorio al sitio web, sin mantener un servidor.
Escribe
- Guías en Markdown y MDX
- Tus propios componentes y diseños
- Referencia de la API a partir de TypeScript
- Colecciones de contenido tipadas
Compila
Las herramientas Rust compilan tu Markdown y colorean cada bloque de código, TypeScript 7 lee tus tipos y Vite empaqueta el resto. El índice de búsqueda, el sitemap y llms.txt salen del mismo horno.
Publica
Cada página es HTML completo. Los buscadores ven todo, los lectores reciben el contenido en la primera petición y sirve cualquier alojamiento estático.
la forma fácil de empezar
Deja que tu agente se encargue de la instalación.
Sin plantilla inicial ni maratones de copiar y pegar. Dale esta frase a tu agente de programación, en un repositorio nuevo o existente. El enlace lleva a las instrucciones oficiales de Ardo. El agente adapta el ejemplo probado y te informa del resultado de la comprobación de tipos, las pruebas y la compilación. Revisas el resultado como cualquier otra pull request.
Configura Ardo en este repositorio siguiendo https://
sí, ese es todo el prompt. puedes ir a por un café.
por dentro
Rápido de principio a fin.
Ardo se apoya en grandes herramientas. Dos de ellas salen de nuestro propio taller, escritas en Rust.
Ferromark
Nuestro compilador de Markdown y MDX. Convierte las páginas en componentes React y extrae los títulos, el índice y los datos de búsqueda.
2,6× más rápido que pulldown-cmark en 50 documentos reales.
Ferriki
Nuestro resaltador de sintaxis. Cada bloque de código recibe sus colores durante la compilación, en claro y oscuro, sin trabajo adicional en el navegador.
4,7× más rápido que Shiki en WebAssembly, con el mismo HTML.
ambos forman parte de Ferramenta, nuestra pequeña familia de herramientas Rust ↑
El compilador nativo lee tus tipos. Generó la documentación de la API de Ardo 4,3× más rápido que TypeDoc.
El servidor de desarrollo que ya conoces. Guarda un archivo y la página se actualiza.
Herramientas Rust que optimizan las páginas compiladas y relacionan tus declaraciones.
tu sistema de diseño encaja aquí
componentes y diseños
Tus componentes son bienvenidos.
Incorpora componentes React locales o un sistema de diseño instalado en MDX. Crea páginas de inicio y diseños en React, acompañados de las tarjetas, pestañas, pasos, acordeones y avisos de Ardo.
Referencia de la API para TypeScript
Tus tipos, ahora con sitio web.
Indica a Ardo tus puntos de entrada de TypeScript para generar páginas de referencia con firmas, parámetros y comentarios. También aparecen en la búsqueda y se actualizan en la siguiente compilación.
generado, sin escribirlo a mano
personalización visual
Dale tu estilo en unas pocas líneas.
Elige los tonos de marca, acento y neutro, y su saturación. Ardo calcula los modos claro y oscuro. ¿Quieres más? Sobrescribe cualquier token o cambia un componente.
verde · naranja · gris cálido
El tema predeterminado de Ardo
azul · verde azulado · pizarra
modo oscuro incluido, para los noctámbulos
dónde encaja Ardo
¿Conoces alguna de estas herramientas? Entonces ya casi conoces Ardo.
- DocusaurusTambién React y MDX, sobre una base más reciente: Vite y Rust, con páginas HTML.
- VitePressTambién Vite y Markdown, con React en lugar de Vue.
- StarlightTambién estático y centrado en el contenido, con React como modelo de página en lugar de isla.
- NextraTambién React y MDX, sin Next.js. El resultado son archivos estáticos.
- FumadocsTambién React, como conjunto de herramientas. Ardo ofrece una configuración completa con sus propias herramientas.
- RspressTambién compila con Rust, sobre Rspack. Ardo usa Vite y lee tu TypeScript.
- VocsTambién React y Vite. Ardo añade una referencia de la API generada y herramientas Rust.
- DocusLa misma idea para Nuxt y Vue. Ardo es su equivalente en React.
- Material for MkDocsUna solución madura, centrada en Markdown y escrita en Python. Ardo se mantiene en el ecosistema de React.
- MintlifyUna plataforma alojada. Ardo es de código abierto y vive en tu repositorio.
¿encaja contigo?
¿Es Ardo tu tipo de búho?
Una buena opción si
- tu producto o biblioteca usa React y TypeScript
- tu documentación debe vivir en el repositorio y pasar por revisión
- quieres páginas prerenderizadas y poco trabajo en el navegador
Quizá no si
- solo quieres texto, sin React (prueba Starlight o VitePress)
- necesitas edición y analítica alojadas (una plataforma alojada se encarga de ello)
¿quién lo creó?
«Buscaba un framework de documentación moderno y ligero que fuera simplemente React. No existía. Así que lo creé».
SebastianSebastian Werner · creador y responsable del mantenimiento
- 1. Un único modelo de componentes. Las páginas y los ejemplos usan React. Sin un segundo framework de interfaz.
- 2. Tu repositorio es la fuente. El contenido, la configuración y el tema pasan por revisión de código.
- 3. Archivos estáticos, sin plataforma. Sin cuentas ni servicios que mantener.
- 4. Afirmaciones verificables. Estado público de las funciones y benchmarks publicados.
¿Todo listo para que nazca tu documentación?
Una frase para tu agente, las instrucciones oficiales y un ejemplo probado. Revisas el resultado como cualquier otra pull request.
creado por
Ardo es un proyecto de código abierto de Sebastian Software, junto con Ferromark, Ferriki y el resto de la familia.
¿necesitas ayuda?
Consultoría de TypeScript, React y Rust: integración, soporte y mantenimiento a largo plazo de quienes desarrollan Ardo.