Fumadocs

Fumadocs es un marco de documentación que ayuda a los desarrolladores a crear sitios de documentación profesionales utilizando React y Next.js. A diferencia de las herramientas de documentación tradicionales, te ofrece control total sobre tu contenido y diseño mientras maneja automáticamente las partes complejas.

Soporta la escritura de contenido en Markdown y MDX, lo que significa que puedes usar formato de texto simple o agregar componentes interactivos de React. El marco incluye búsqueda integrada, resaltado de sintaxis y hermosos temas pre-diseñados. También funciona con cualquier fuente de contenido, ya sea que almacenes tus documentos en archivos, una base de datos o un sistema de gestión de contenido.

Fumadocs está construido en torno a tres partes: una capa de contenido para gestionar tus documentos, una biblioteca central para funciones como la búsqueda, y una biblioteca de interfaz de usuario para componentes atractivos. Puedes usar solo lo que necesites.

Comenzar con Fumadocs es sencillo. Aquí están los pasos:

• Instala el framework ejecutando el comando npm create fumadocs-app en tu terminal. Elige tu framework React preferido y la fuente de contenido cuando se te solicite.

• Escribe tu contenido en archivos MDX dentro de la carpeta docs. Usa sintaxis Markdown simple con la opción de agregar componentes React para elementos interactivos.

• Personaliza la apariencia usando Tailwind CSS. Puedes cambiar colores, diseños y estilos para que coincidan con tu marca sin necesidad de aprender un sistema nuevo.

• Agrega funcionalidad de búsqueda conectando Orama o Algolia con solo unas líneas de código. El framework se encarga del resto automáticamente.

• Usa la herramienta CLI para añadir componentes interactivos como pestañas, llamadas de atención y bloques de código con el comando npx @fumadocs/cli add.

• Despliega tu sitio en Vercel, Netlify o cualquier servicio de hosting que soporte aplicaciones Next.js.

• Marco gratuito y de código abierto

• Funciona con Next.js, React Router y otros frameworks de React

• Escribe contenido en Markdown y MDX

• Búsqueda integrada con soporte para Orama y Algolia

• Generador de documentación OpenAPI

• Integración de TypeScript Twoslash

• Hermosos componentes de interfaz pre-diseñados

• Herramienta de línea de comandos para una configuración fácil

• Resaltado de sintaxis con Shiki

• Altamente personalizable con Tailwind CSS