From 9aaae8940d68cc38dbf44a69f5ba9a02b5aef2ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Echedey=20L=C3=B3pez=20Romero?= Date: Wed, 6 Jan 2021 18:18:39 +0000 Subject: [PATCH] =?UTF-8?q?Creada=20descripci=C3=B3n=20inicial.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1b69b87..4c9ad2d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,27 @@ # Web -Por hacer... +Este proyecto consiste en un sitio web estático desarrollado con [Jekyll]() con el tema [no-style-please]() a modo de blog para realizar hablar del Software Libre y de Código Abierto. -## Publicaciones -### Fecha +## Estructura +El sitio web consta de una página inicial declarada solo con la cabecera como fichero en [Markdown]() en `index.md` y especificada en formato [YAML]() y situada en `_data/menu.yml` a modo de lista. En la misma, se declara los enlaces a las distintas publicaciones y resto de páginas del sitio. + +Las publicaciones, están escritas en Markdown, adjuntando una cabecera adicional descrita más adelante, y situadas en `_posts/`. + +Por defecto, en la página inicial no se listan todas las publicaciones, sino que tienen un máximo definido y pasando al archivo cuando sobre pasa el límite. El archivo es un conjunto de ficheros en Markdown que constan de una única cabecera y están situados en `archive/`. Existe uno general y otro por cada categoría. + +Las configuraciones generales del sitio se declaran en el fichero `_config.yml`, y el fichero Gemfile indica las dependencias de []() que necesita el sitio. + +## Funcionamiento + +La web es actualizada cada 5 minutos usando un script en la [crontab]() del usuario donde estáá instalado Jekyll. + +El script actualiza la copia del repositorio local, descarga o instala las dependencias de Ruby correspondientes y genera compila el sitio desde los ficheros fuente. + +El script es el fichero `update.sh`. + +## Contribución +### Publicaciones +#### Cabecera +##### Fecha La fecha debe seguir el formato %Y-%m-%d %H:%M:%S %z en cada publicación. Una buena forma de obtenerla es especificándola como entrada al programa `date` de la siguiente forma.