Workspace Antora

Este directorio (code/docs/) contiene el sitio Antora del repositorio, la capa de personalizacion visual y la logica auxiliar para empaquetar la UI y generar paginas derivadas de los README.

Scripts utiles

cd code/docs
npm ci
npm run build:dev
npm run preview

Otros comandos relevantes:

  • npm run build:prod: construccion local usando antora-playbook.yml.

  • npm run ui:bundle: regenera ui/ui-bundle.zip.

  • npm run ingest: actualiza las paginas generadas desde README.

  • npm run watch: recompila al detectar cambios en modulos, readmes y overrides de UI.

Ficheros clave

  • antora.yml: define componente, titulo y navegacion.

  • antora-playbook.dev.yml: build offline con UI local extraida.

  • antora-playbook.yml: build para publicacion.

  • ingest-readmes.js: genera paginas auxiliares a partir de README.

  • scripts/bundle-ui.js: empaqueta la UI sin depender de herramientas externas.

  • ui/supplemental/**: overrides de parciales y assets del tema.

Que revisar si algo falla

  • Si un cambio visual no aparece, reconstruye con npm run build:dev.

  • Si el zip de UI se queda desfasado, ejecuta npm run ui:bundle.

  • Si quieres revisar la relacion entre README y docs, consulta Ingesta de README.

  • Si necesitas entender el despliegue a GitHub Pages, consulta Publicacion.