Me ha gustado el theme «Minimal Mistakes» (Jekyll theme gem ) para generar un sitio con información de un proyecto.
Posts relacionados:
Instalando el theme
Para alojarlo en GitHub Pages debemos hacer un fork del repositorio original (crea una copia exactamente igual del original) se puede usar este enlace para hacer un fork del theme o directamente copiar todos los ficheros descargándolos.
Ya tengo creada una copia en mi GitHub del theme haciendo un fork.
Recomendación: Borrar las carpetas /docs y /test.
Ahora para convertirlo en una página de GitHub vamos a la configuración del repositorio («Settings»), aprovechamos para cambiar el nombre del repositorio. La página se carga del contenido dentro de la carpeta «/docs».
Ahora ya podemos ver la nueva página:
Configuración
Los parámetros de configuración globales que afectan a toda la Web se pueden encontrar en el fichero en el raíz _config.yml (fichero de configuración Jekyll).
Modificamos la información de la página (title, name, description, url, baseurl, repository), parámetros de redes sociales como Twitter.
Skin
Podemos cambiar el esquema de colores del theme seleccionando entre los disponibles:
minimal_mistakes_skin : "default" # "air", "contrast", "dark", "dirt", "mint", "sunrise"
Nota: Podemos personalizar los estilos modificando /assets/css/main.scss
Cambiando el idioma
El contenido de texto para los elementos gráficos del interface de usuario están agrupados en _data/ui-text.yml.
Podemos modificar el idioma en _config.yml con el parámetro «locale».
locale : "es"
Navegación
Para definir los títulos de enlaces y la URL destino debemos modificar ‘_data/navigation.yml‘ (dentro de carpeta docs).
Los nuevos elementos se posicionaran de forma horizontal en forma de menú.
Posts
Las entradas se almacenan en la carpeta «_posts/«, podemos habilitar el menú de acceso a las entradas en «_data/navigation.yml» para que se muestre una lista de las entradas ordenadas por fecha.
Los enlaces se la sección «docs» se encuentran más abajo dentro de navigation.yml
Dentro de la carpeta «_posts» cada entrada es un fichero Markdown con la fecha en el nombre:
Para saber algo más sobre la estructura de las entradas podemos consultar la entrada de Jekyll sobre posts.
Vamos a consultar que aspecto tiene este post con título «Layout: Header Video«:
Editamos el fichero «_posts/2017-01-23-layout-header-video.md«:
El post debería mostrar un vídeo en la cabecera.
Un post básico debería contener como mínimo una cabecera con estos campos:
Vamos a crear un post nuevo «_posts/2017-10-08-mi-primer-post.md«:
Los campos entre «—» son la cabecera del documento. Añadimos un título, las categorías permiten agrupar los posts relacionados, por ejemplo los relacionados con «Post Formats«. Algo similar hacemos con las etiquetas que comparten los posts.
Para consultar diferentes formatos de posts con vídeos, galerías de fotos y otros contenidos podemos revisar cada post de ejemplo uno por uno.