esofitec. CoreDocs

esofitec. CoreDocs

Operación del motor

Despliegue local

Esta es la forma recomendada de validar contenido y comportamiento antes de publicar.

Requisitos#

  • Python 3.10 o superior
  • pip
  • acceso de lectura a CoreDocs.Engine y CoreDocs.Tech

Preparación del entorno#

cd CoreDocs.Engine
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Generación#

python generator.py

El motor:

  • valida config.json
  • comprueba content_root
  • descubre categorías y Markdown
  • limpia output_root
  • regenera el portal completo

Resultado esperado#

dist/
  index.html
  search-index.json
  static/
  documentador/
  s360-proyectos/

Servir la salida localmente#

Si quieres probar navegación y autenticación en un navegador:

python3 -m http.server 8080 -d dist

Y accede a:

http://localhost:8080/

Qué revisar antes de darlo por bueno#

  • la categoría nueva aparece en Inicio
  • el sidebar agrupa bien los artículos
  • las imágenes y enlaces funcionan
  • la búsqueda local no devuelve resultados de otras categorías
  • los artículos renderizan admonitions, tablas y código

Cuándo cambiar output_root#

Solo si necesitas:

  • separar salida de build y código fuente
  • integrar una carpeta de staging local
  • preparar una carpeta concreta para otro proceso

En la mayoría de casos locales, deja dist.

Práctica recomendada

No publiques dist/ en el repositorio. Trátalo como artefacto generado.