web/README.md

30 lines
1.7 KiB
Markdown
Raw Normal View History

2021-01-03 02:30:02 +01:00
# Web
2021-01-06 19:18:39 +01:00
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.
2021-01-03 02:30:02 +01:00
2021-01-06 19:18:39 +01:00
## 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
2021-01-03 23:22:35 +01:00
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.
`date +"%Y-%m-%d %H:%M:%S %z"`