Descripción General

Boltdocs convierte una carpeta de archivos Markdown en un sitio de documentación completamente renderizado, indexado para búsqueda y optimizado para SEO. Estas guías te acompañan por cada capa del framework — desde poner tu primera página en línea en dos minutos hasta construir layouts completamente personalizados e inyectar tus propios componentes React en MDX.

Por Dónde Empezar

Estructura del Proyecto

Un proyecto Boltdocs recién creado se ve así:

my-docs/
├── docs/                  # Todo tu contenido vive aquí
│   ├── (guides)/
│   │   └── index.mdx
│   └── index.md           # Página raíz → /docs
├── public/                # Assets estáticos (imágenes, fuentes, favicons)
│   ├── dark.svg
│   └── light.svg
├── src/
│   └── components/        # Tus componentes React personalizados
├── boltdocs.config.ts     # El cerebro de tu sitio de docs
├── index.html             # Punto de entrada HTML de Vite
├── index.css              # Estilos globales
└── package.json

Directorios Clave

docs/ — Todo aquí se convierte en una página. Boltdocs escanea recursivamente archivos .md y .mdx y los convierte en rutas. La estructura de carpetas se mapea directamente a la estructura de URLs.

boltdocs.config.ts — La única fuente de verdad. Controla el tema, navegación, plugins, SEO, i18n y más. Boltdocs genera la configuración completa de Vite internamente — no necesitas un vite.config.ts separado.

public/ — Assets estáticos servidos desde la raíz de tu sitio. Referéncialos en Markdown con una ruta relativa a la raíz como /mi-imagen.png.

src/components/ — Tus componentes React personalizados, disponibles para importar en archivos .mdx o registrar como componentes MDX globales a través de plugins.

Todas las Guías