Introducción
Fumadocs (Foo-ma docs) es un marco de documentación basado en Next.js, diseñado para ser rápido y flexible, y para integrarse con naturalidad en el App Router de Next.js.
Fumadocs tiene varias partes:
Fumadocs Core
Se encarga de la mayor parte de la lógica, incluida la búsqueda de documentos, los adaptadores de origen del contenido y las extensiones de Markdown.
Fumadocs UI
El tema predeterminado de Fumadocs ofrece un aspecto cuidado para los sitios de documentación y componentes interactivos.
Origen del contenido
El origen de su contenido puede ser un CMS o una capa de datos local, como Fumadocs MDX (el origen de contenido oficial).
Fumadocs CLI
Una herramienta de línea de comandos para instalar componentes de interfaz y automatizar tareas. Resulta útil para personalizar los diseños.
¿Quiere saber más?
Lea nuestra introducción detallada Qué es Fumadocs.
Terminología
Markdown/MDX: Markdown es un lenguaje de marcado para crear texto con formato. Fumadocs admite Markdown y MDX (un superconjunto de Markdown) de forma nativa.
Aunque no es obligatorio, unos conocimientos básicos del App Router de Next.js le serán útiles para personalizaciones posteriores.
Instalación automática
Se requiere como mínimo Node.js 18. Tenga en cuenta que Node.js 23.1 puede tener problemas con la compilación de producción de Next.js.
npm create fumadocs-appLe preguntará lo siguiente:
- el framework de React.js que desea usar (la documentación solo está escrita para Next.js);
- el origen del contenido que desea usar.
Se inicializará una aplicación nueva de Fumadocs. Ya puede empezar a trabajar.
¿Parte de un código existente?
Puede seguir la guía de instalación manual para empezar.
A trabajar
Cree su primer archivo MDX en la carpeta docs.
---
title: Hello World
---
## Yo what's upEjecute la aplicación en modo de desarrollo y abra http://localhost:3000/docs.
npm run devPreguntas frecuentes
Algunas preguntas habituales que puede encontrar.
Actualizar Fumadocs
Actualice Fumadocs si encuentra algún problema o quiere probar funciones nuevas:
pnpm update -i -r --latestMás información
¿Acaba de llegar? No se preocupe: sus preguntas son bienvenidas.
Si algo le resulta confuso, envíe sus comentarios en Github Discussion.
Redactar contenido
Para escribir documentación, lea lo siguiente:
Markdown
Fumadocs incluye funciones adicionales para redactar contenido.
Navegación
Aprenda a personalizar los enlaces de navegación y los elementos de la barra lateral.
Enrutamiento
Aprenda a organizar el contenido.
Componentes
Consulte todos los componentes disponibles para mejorar su documentación