Saltar al contenido principal

Publicar documentación

Estructura y versión​

El sitio utiliza la estructura de Envorenn: Docusaurus 3.10.2, una carpeta website/, la documentación raíz y un CI para el corredor shell. La documentación para Podbook está inicialmente en francés.

El tiempo de ejecución de CI es Node 26.12.0, instalado localmente mediante bootstrap e indicado en .nvmrc. El script compara el archivo con su suma oficial SHA-256 y no sobrescribe el sistema Node.

Trabajar localmente​

Con Node 22 o más reciente:

cd website
npm ci
npm start

Para comprobar el sitio de producción:

npm run check
npm run serve

npm run check prueba la resolución de la URL y luego crea el sitio. Los enlaces internos rotos, los anclajes y los enlaces Markdown hacen que la compilación falle.

Para reproducir el tiempo de ejecución de CI exactamente desde la raíz:

python3 website/scripts/bootstrap-node.py
export PATH="$PWD/website/.node-runtime/bin:$PATH"
cd website
npm ci
npm run check

Tubería GitLab​

GatilloResultado
Rama de trabajo o solicitud de fusiónnpm ci, pruebas y construcción, sin publicación.
Rama predeterminadaMismos controles, luego publicación como artefacto public/ del trabajo Páginas.

El corredor debe estar activado para este proyecto, con Python 3, tar y acceda a HTTPS para nodejs.org y registrar npm. Bootstrap es compatible con Linux y macOS, x64 o arm64. La caché npm acelera las instalaciones posteriores.

El repositorio contiene las fuentes y el archivo de bloqueo, no node_modules, .docusaurus, build, .node-runtime o public.

URL de publicación​

La dirección clásica preparada, basada en el modelo de Envorenn, es:

http://kourser.pages.git.cythin.eu/podbook/

Esta dirección es una configuración, no una prueba de una implementación. comprobar Implementar → Páginas en GitLab después de la primera canalización exitosa.

PAGES_URL contiene la URL completa, la ruta incluida y el texto principal CI_PAGES_URL. Sin estas variables, la configuración utiliza la dirección clásica anterior. El origen y la subruta se derivan juntos para mantener los recursos correctos bajo control. /podbook/.

Para un dominio personalizado o único GitLab, establezca PAGES_URL en las variables del proyecto con la dirección realmente configurada, luego reinicie la canalización. El DNS del dominio debe ser compatible con la instancia. El sitio no cambia esta configuración ni los controles de acceso a las páginas.

Actualizar páginas​

  • website/docs/ : guía de usuario en francés.
  • website/sidebars.js : orden de sus páginas.
  • docs/ : estudios publicados directamente bajo /conception/, sin generar copia.
  • website/src/css/custom.css : paleta y bienvenida.
  • website/static/img/ : icono de la aplicación integrada en el sitio.

Después de un cambio, ejecute npm run check, verifique la visualización en pantalla ancha y estrecha, luego incruste las fuentes en la rama predeterminada para activar Páginas.

Referencias: Docusaurus y trabajo GitLab Páginas.