jekyll

Permite la creación de sitios web estáticos a partir de documentos en formato markdown.

Otra opción para utilizar esta herramienta es instalarla dentro del servicio web.

Comprobar que en el fichero .services está descomentada la línea con el servicio jekyll.
Ejecutar ./up.sh desde la carpeta odoodock.

Crear sitios web

El directorio de trabajo por defecto es la carpeta /mnt/extra-addons, que da acceso a todos los módulos que se están desarrollando. En general será necesario acceder a la subcarpeta del módulo para la gneneración de la documentación asociada.

Si se desea publicar en GitHub Pages, el código fuente del sitio debe almacenarse en la carpeta docs

Existen dos opciones:

O1. Desde dentro del contenedor

Desde la carpeta odoodock, ejecutar:

docker exec -it odoodock-jekyll-1 bash
> cd MI_MODULO
> jekyll new docs
> cd docs
> bundler add webrick

donde MI_MODULO es la carpeta que contiene el módulo y docs la carpeta que contendrá el código jekyll del sitio.

O2. Desde fuera del contenedor

Desde la carpeta odoodock, ejecutar:

docker exec -it odoodock-jekyll-1 bash -c "cd MI_MODULO \ 
 && jekyll new docs \
 && cd docs \
 && bundler add webrick"   

donde MI_MODULO es la carpeta que contiene el módulo y docs la carpeta que contendrá el código jekyll del sitio.

El servicio jekyll está pensado para dar soporte a un único site. En caso de querer crear más de uno, es necesario parar y volver a arrancar el contenedor o arrancar tanto servicios como sites deseemos.

Construir/servir el sitio

El proceso de construcción (build) o de servir (serve) el site es muy similar. La forma más sencilla es entrando en el contenedor.

Para construir:

docker exec -it odoodock-jekyll-1 bash
> cd MI_MODULO\docs
> jekyll build

Para servir:

docker exec -it odoodock-jekyll-1 bash
> cd MI_MODULO\docs
> jekyll server 

En este caso, desde la URL http://locahost:4001 es posible acceder a la documentación.

En función de los posibles contenedores arrancados, el puerto puede variar entre el 4001 y el 4010. El puerto asignado puede ser localizado utilizando el comando docker ps -a.