Saltar al contenido

Introducción

Ver como Markdown Editar en GitHub Documentación de 7b38e05

Onedocs es un conjunto de diseños, componentes y funciones auxiliares para sitios de documentación creados con Next.js y Fumadocs. Escribes Markdown, describes tu sitio en un único archivo de configuración y Onedocs proporciona la estructura de documentación, una página de inicio y las rutas SEO.

Está pensado para sitios de documentación independientes, no para añadir documentación a una aplicación existente.

Qué añade Onedocs

Además de Fumadocs, el paquete onedocs ofrece:

  • Diseños - DocsLayout y DocsPage envuelven el diseño de documentación Fumadocs UI, con barra lateral, búsqueda, selector de tema y tabla de contenido. HomePage muestra una página de inicio con contenido destacado, comandos de instalación, funciones y pie de página.
  • Un archivo de configuración - onedocs.config.ts contiene el título, la descripción, el logotipo, el favicon, los enlaces de navegación, el pie de página y el contenido de la página de inicio.
  • Componentes MDX - mdxComponents registra avisos, pestañas, tarjetas, pasos, acordeones, árboles de archivos, zoom de imágenes y tablas de tipos para usarlos en las páginas sin importarlos.
  • Ajuste preestablecido de CSS - una importación incorpora Tailwind CSS v4, el tema Fumadocs UI y los estilos de diseño Onedocs.
  • Funciones auxiliares de SEO - funciones para sitemap.xml, robots.txt, llms.txt, llms-full.txt, metadatos de página e imágenes Open Graph.

Lo que debes configurar tú

Onedocs no incluye Next.js ni Fumadocs. Son dependencias de pares que debes instalar junto con él:

Shell
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom

También necesitas Tailwind CSS v4, Node.js 20.9 o posterior y unos diez archivos pequeños: el archivo de configuración de Next.js y Fumadocs MDX, una fuente de contenido, el diseño raíz, el diseño de documentación y la ruta de la página de documentación. Primeros pasos muestra cada uno.

Dónde se configura cada cosa

Qué Dónde
Título del sitio, logotipo, navegación y pie de página onedocs.config.ts; consulta Configuración
Contenido destacado y funciones de la página de inicio homepage en onedocs.config.ts, que muestra HomePage en src/app/page.tsx
Diseño y páginas de documentación src/app/docs/layout.tsx y src/app/docs/[[...slug]]/page.tsx; consulta Primeros pasos
Carpeta de contenido y orden de la barra lateral source.config.ts y content/docs/meta.json
Componentes MDX mdxComponents; consulta Componentes
Búsqueda, mapa del sitio, robots.txt, llms.txt Archivos de ruta en src/app/; consulta SEO y búsqueda
Metadatos e imágenes Open Graph onedocs/metadata y onedocs/og; consulta la referencia de API

Filosofía

  • Markdown primero - Escribe .md o .mdx y obtén documentación
  • Un archivo de configuración - Los ajustes de todo el sitio están en onedocs.config.ts
  • Opciones para ampliar - ¿Necesitas más control? Usa Fumadocs directamente

Empieza aquí