Réalisation d'un portfolio numérique avec Jekyll
Cet article présente brièvement comment ce site a été construit en utilisant des technologies libres et open sources.
Hébergement
GitHub permet d’héberger des sites via son service Pages.
L’une des méthodes pour l’activer consiste à créer un dossier docs
dans le dépôt du projet.
En allant ensuite dans les options (Settings), de descendre jusqu’à l’encart GitHub Pages
et de sélectionner la source master branch /docs folder
.
Le site sera immédiatement disponible à l’adresse https://nom d'utilisateur
.github.io/nom du projet
,
comme par exemple https://parastuffs.github.io/esnu/
Générer un site web statique
GitHub Pages se contente d’afficher des pages web statiques, c’est-à-dire dont le contenu est généré à l’avance et ne peut pas être modifié par les visiteurs.
Pour générer un tel site, on peut utiliser Jekyll fonctionnant avec Ruby en utilisant la commande suivante pour l’installer : gem install bundler jekyll
Mais au lieu de créer un site entier à partir de rien, il est plus simple et rapide de partir d’un thème existant.
Par exemple, on peut utiliser jasper2 dont il suffit de télécharger l’archive dans le dépôt du projet.
Depuis le dossier jasper2
, une seule commande permet de générer le site : bundle exec jekyll serve
.
Cette opération génère tous les fichiers du site web dans le dossier jasper2-pages
par défaut et héberge une version locale du site à l’adresse http://127.0.0.1:4000/jasper2/
Configuration de jasper2
Le premier fichier de configuration à mettre à jour est le principal : _config.yml
.
Toutes les options sont commentées dans le fichier, mais l’une des essentielles est le dossier de destination à changer en ../docs/
ainsi que l’option baseurl
.
Gérer les tags
Pour ajouter un tag, ça se passe dans le fichier _data/tags.yml
.
Il faut ensuite ajouter les lignes suivantes dans le fichier :
nouveau-tag:
name: nouveau-tag
description: Déroulé du projet.
cover: assets/images/couverture.jpg
où nouveau-tag
est le nom de votre nouveau tag.
Vous pouvez lui ajouter une description et une image de couverture, mais ces derniers sont facultatifs.
Le résultat peut donner quelque chose comme ceci.
Gérer les auteurs
Cette fois-ci, c’est au fichier _data/authors.yml
qu’il faut ajouter les lignes suivantes :
quentin:
username: johnny
name: John Mouette
url: https://perdu.com/
url_full: https://perdu.com/
bio: J'aime les mouettes
cover: false
picture: assets/images/orlyowl.jpg
location: false
facebook: False
twitter: False
Le résultat peut donner quelque chose comme ceci.
Écrire un article
Un article est un fichier Markdown placé dans le dossier _posts
. Son nom doit commencer par sa date de publication, suivie de son titre, par exemple : 2020-01-17-realisation-portfolio-numerique.md
.
Le début du fichier doit toujours contenir des informations sur son contenu, comme son titre, son auteur, etc.
---
layout: post
current: post
cover: assets/images/typewriter.jpg
navigation: True
title: Réalisation d'un portfolio
date: 2020-01-17 10:18:00
tags: coulisses
class: post-template
subclass: 'post tag-coulisses'
author: quentin
---
Davantage d’informations et de détails sont disponibles dans la documentation de Jekyll.
Le fichier ayant servi à générer ce site se trouve par exemple ici.
Brouillons
Les brouillons doivent être écrits dans un dossier _drafts
et ne nécessitent pas de date dans leur nom de fichier.
Ensuite, si vous souhaitez les voir sur la version locale de votre site, il faut compiler le site en ajoutant une option à la commande : bundle exec jekyll serve ---draft
.