Instalación
Instala Boltdocs y ejecuta tu primer sitio de documentación en menos de dos minutos.
Boltdocs requiere Node.js 18+ y un gestor de paquetes. Recomendamos pnpm por su velocidad y eficiencia en disco, pero npm y yarn también funcionan perfectamente.
Si estás empezando desde cero, usa create-boltdocs para generar un proyecto completo con todo el boilerplate listo:
pnpm create boltdocs@latest my-docs
Luego salta directamente a ejecutar el servidor de desarrollo.
pnpm 10+ bloquea los scripts de lifecycle (preinstall/postinstall) de las dependencias por defecto. El template de create-boltdocs ya incluye la configuración requerida pnpm.onlyBuiltDependencies, así que pnpm install funciona sin problemas. Si estás agregando Boltdocs a un proyecto existente de forma manual, consulta la guía de solución de problemas para la configuración requerida.
Instalación Manual
Si estás agregando Boltdocs a un proyecto existente, instálalo como dependencia de desarrollo:
# pnpm
pnpm add -D boltdocs
# npm
npm install --save-dev boltdocs
# yarn
yarn add --dev boltdocs
Crea el Directorio de Docs
Boltdocs espera que tu contenido viva en una carpeta docs/ en la raíz de tu proyecto. Créala y agrega tu primera página:
mkdir docs
echo "# Hello, Boltdocs!" > docs/index.md
Agrega un Archivo de Configuración
Crea boltdocs.config.ts en la raíz de tu proyecto:
import { defineConfig } from 'boltdocs'
export default defineConfig({
siteUrl: 'https://my-project.com',
theme: {
title: 'My Project Docs',
githubRepo: 'my-org/my-project',
},
})
Este archivo es la única fuente de verdad para tu sitio de documentación. No necesitas un vite.config.ts — Boltdocs genera la configuración completa de Vite internamente.
Agrega Scripts a package.json
{
"scripts": {
"docs:dev": "boltdocs",
"docs:build": "boltdocs build",
"docs:preview": "boltdocs preview"
}
}
Ejecuta el Servidor de Desarrollo
pnpm docs:dev
Abre http://localhost:5173 y verás tu sitio de documentación ejecutándose localmente con hot reload.
El primer inicio es un poco más lento mientras Boltdocs construye su mapa de rutas interno y calienta el caché de archivos. Los reinicios posteriores son casi instantáneos.
Construye para Producción
pnpm docs:build
El resultado se genera en dist/. Cada página se pre-renderiza como HTML estático, con un bundle del cliente para navegación y búsqueda.
¿Qué Sigue?
Configuración
Aprende a personalizar el título, logo, navegación y cada otra opción en tu archivo de configuración.
Enrutamiento por Sistema de Archivos
Aprende cómo Boltdocs convierte tu carpeta docs/ en una estructura de navegación completa.