Publicar la documentación

Solo mantenedores

Esta página explica publicar el sitio desde el código privado. Quien desarrolla una aplicación solo necesita instalar y usar el paquete público, sin acceso al repositorio ni permisos para publicar.

Construcción y vista previa

pnpm

pnpm install --frozen-lockfile
pnpm docs:check
pnpm docs:build
pnpm docs:preview

npm

npm install
npm run docs:check
npm run docs:build
npm run docs:preview

Bun

bun install
bun run docs:check
bun run docs:build
bun run docs:preview

Yarn

yarn install
yarn docs:check
yarn docs:build
yarn docs:preview

Usa Node 20 o posterior. Para construir el repositorio de forma reproducible, usa pnpm y su lockfile versionado. La salida es docs/.vitepress/dist.

Vercel

Importa el repositorio GitHub. vercel.json selecciona VitePress, comprueba la documentación, construye y publica docs/.vitepress/dist. Ambos idiomas son archivos estáticos; no requieren funciones de servidor.

Netlify y Cloudflare Pages

Usa pnpm docs:check && pnpm docs:build como comando y docs/.vitepress/dist como directorio de salida. La raíz es la del repositorio, con Node 20+. Netlify también dispone de netlify.toml versionado.

GitHub Pages y subrutas

DOCS_BASE=/serial-node-jsd/ pnpm docs:build

Publica el contenido de docs/.vitepress/dist como artefacto Pages. Usa la misma base al previsualizar. En la raíz no hace falta DOCS_BASE.

Las páginas usan URLs .html explícitas para no depender de reescrituras de URLs limpias. Las portadas siguen siendo / y /es/.

Mantener traducciones

El inglés es canónico en docs/; el español replica todas sus rutas en docs/es/. La navegación y las etiquetas de búsqueda están traducidas. Conserva rutas relativas idénticas al agregar páginas para mantener el tema al cambiar de idioma. Ejecuta pnpm docs:generate al modificar eventos o firmas.

Antes de publicar, previsualiza la salida de producción, cambia de idioma en una página API, sigue el menú lateral y anterior/siguiente, prueba la búsqueda y recarga una URL interna.