HaikoOz
Photo de Zalfa Imani sur Unsplash

Niepce, le kit pour portfolio statique

Depuis que j'ai refait ce blog en site statique avec Eleventy je suis tombé amoureux de cet outil et j'ai décidé de refaire aussi mon portfolio avec. Mais j'ai remarqué qu'il y avait peu ou pas de starter kit dans la communauté pour créer son portfolio. Alors je l'ai fait… pour moi d'abord et puis pour les autres ensuite.

Pourquoi, comment et à quoi ça ressemble donc ? #

Niepce est un starter kit pour vous aider à construire votre portfolio statique avec Eleventy sans que vous ayez à tout faire vous même.

Il est prêt à être généré tel quel mais vous aurez quelques petites choses à régler tout de même pour le faire vôtre.

Le but premier était de rendre ce starter kit de portfolio souple, configurable et, autant que faire se peut, accessible au plus grand nombre sauf qu'Eleventy a beau être génial, on va pas se mentir, c'est pas à la portée du premier ou de la première venue; un certain niveau minimum de savoir technique est requis.
J'ai fait du mieux que j'ai pu mais à un moment il faudra mettre les mains dans le cambouis, pas le choix.

Pour voir à quoi ça ressemble pas besoin d'aller bien loin, je vous invite à aller voir mon portfolio, c'est encore le plus simple. Vous ne pourrez pas voir toutes les possibilités mais c'est déjà un bon aperçu.

Les fonctionnalités intégrées #

Logo personnalisé #

Si vous avez votre propre logo, vous pourrez l'ajouter facilement.
Si vous n'en avez pas c'est le nom du portfolio qui prendra sa place.

Attention toutefois, le nom devra être court sous peine de passer à la ligne, c'est pourquoi un logo est tout de même préférable.

Bannière pour les partages sociaux avec OpenGraph #

Quand vous ou quelqu'un d'autre partagera un lien vers votre site sur les réseaux sociaux ou sur toute autre plateforme qui gère Opengraph cela affichera une carte avec les informations essentielles de la page partagée.

Un peu comme ceci : capture d'écran d'un partage sur Twitter usant d'OpenGraph

Pour les pages de vos photos, ce sera déjà pris en charge mais pour le reste vous pouvez choisir une bannière personnalisée.

Les tons clair et obscur #

Niepce existe en 3 saveurs :

En bref, vous avez le choix de forcer un des deux tons ou de laisser les préférences utilisateurs choisir à votre place.

Le ton clair Capture d'écran du ton clair

Le ton obscur Capture d'écran du ton obscur

4 choix de présentation #

Vous avez le choix entre 4 façons pour présenter les galeries :

Dans le portfolio, deux types de page sont candidats à afficher une de ses présentations :

Vous aurez la possibilité de choisir une présentation globale (pour les 2 types de page donc) ou présenter les choses de manière différente sur chaque type.

La grille Justified Capture d'écran de la grille justified

La grille Masonry Capture d'écran de la grille masonry

La grille Instagrid Capture d'écran de la grille instagrid

La grille Monocolumn Capture d'écran de la grille monocolumn

Affichage des métadonnées EXIF #

Vous pouvez décider d'afficher ou non quelques métadonnées EXIF tirées des photographies. Évidemment si votre portfolio ne présente pas de photographie mais plutôt des peintures, dessins ou que sais-je, ça ne vous sera pas d'utilité.

Les métadonnées récupérées et affichées (si elles sont disponibles) sont :

Affichage des tags #

Dans le portfolio les tags appliqués aux photos servent à générer les catégories qui apparaissent dans le menu latéral.
Il ne vous sera peut être donc pas d'utilité d'afficher ces tags sur la page d'une photo.
Dans tous les cas vous aurez la possibilité d'afficher ces tags ou non.

Liens réseaux sociaux #

Il est souvent utile (malheureusement ?) d'afficher les profils de nos réseaux sociaux. Un set prédéfinis de réseau n'attendent que vos URLs pour être affichés.

Dans la liste non-exhaustive nous avons pour le moment :

Je n'ai pas mis tous les réseaux pour présenter son travail surtout parce que… pour certains je n'ai pas trouvé des logo en SVG satisfaisant ou je n'ai pas juger bon de le rajouter. Mais ça pourrait évoluer.

Dans tous les cas, il est clairement possible de rajouter ses propres réseaux ou de me demander d'en rajouter un.

Liens externes #

Si comme moi votre portfolio a son propre nom de domaine et que vous souhaitez afficher des URLs personnelles ailleurs (comme votre blog par exemple) il sera tout à fait possible de le faire.

Le principe est peu ou prou le même que pour les réseaux sociaux, il vous sera demandé une URL et un label pour le lien.

Comment le mettre en place #

Prérequis #

Afin de pouvoir installer et utiliser Niepce il va falloir un environnement prêt à le recevoir. Pas besoin de grand chose mais un peu quand même :

Récupérer les sources #

Tout est sur Github.

De là, libre à vous de cloner le dépôt git en ligne de commande

mkdir mon-portfolio
git clone https://github.com/GoOz/Niepce.git mon-portfolio

ou de télécharger l'archive directement depuis le bouton télécharger de Github.

vous ne pourrez pas push sur mon dépôt git donc si vous voulez continuer sur git ensuite pour versionner votre portfolio il vous faudra changer le remote.

Mise en place de l'environnement #

Pour commencer il va falloir installer tout ce dont nous avons besoin. Pour ce faire ouvrez votre terminal, si ce n'est déjà fait, et tapez ce qui suit

cd mon-portfolio
npm install

La commande npm install va aller chercher les quelques dépendances et les installer pour vous. Promis il n'y en a pas beaucoup.

Une fois l'installation terminée, vous devriez être en mesure de lancer le site en local en tapant

npm run start

et une fois que le terminal vous affiche

[11ty] Watching…
[11ty] Server at http://localhost:8080/

cela voudra dire que c'est prêt, donc ouvrez un nouvel onglet de votre navigateur préféré et aller sur http://localhost:8080/

Vous devriez y voir la même chose que sur les captures d'écran présentées plus haut.

Configuration #

Maintenant que votre site tourne localement il est temps d'éditer la configuration pour le transformer en votre portfolio.

Toute la configuration se fera dans 2 fichiers :

Ces deux fichiers sont déjà partiellement pré-remplis et, de base, vous ne devriez avoir qu'à remplir des champs vides ou éditer des valeurs existantes.

Prenons d'abord le fichier metadata.json

{
"title": "Niepce",
"url": "https://portfolio.niepce.tld",
"language": "en",
"locale": "en_US",
"description": "Niepce's personal portfolio",
"author": {
"name": "Nicéphore Niépce",
"email": "nicephore@niepce.tld",
"url": "https://www.niepce.tld"
}
}

Je ne pense pas qu'il y ait besoin de tout décrire sur ces informations, toutefois je préciserais que :

Vient ensuite le fichier niepce.js et là je vais rentrer dans le détail.

module.exports = {
grid: "masonry",
grid_tags: "justified",
theme: "auto",
logo: "",
banner: "",
exif: true,
tags: true,
socials: {
"500px": "",
behance: "",
deviantart: "",
flickr: "",
glass: "",
instagram: "",
notos: "",
pixelfed: "",
tumblr: "",
},
links: [
{
label: "",
url: "",
},
],
}

Clé grid
Valeur masonry | justified | instagrid | monocolumn
C'est votre choix de grille pour la home et pour les pages de catégorie.

Clé grid_tags
Valeur masonry | justified | instagrid | monocolumn
C'est votre choix de grille pour les pages de catégorie. Si elle n'est pas définie alors c'est le choix grid qui sera utilisé pour ces pages.

Clé theme
Valeur light | dark | auto
Force un ton en particulier ou bien laisse les préférences utilisateur choisir automatiquement.

Clé logo
Valeur String
Chemin vers votre logo (de n'importe quel format d'image qui soit supporté par une balise HTML img). Il peut être n'importe où, même distant. Si aucun logo n'est spécifié alors c'est le title de metadata.json qui prendra le relai et sera affiché.
Si c'est un SVG et que vous voulez l'intégrer à la page pour que sa couleur s'adapte au thème, ajoutez un suffixe -inline au nom du fichier (ex: logo-inline.svg).

Clé banner
Valeur String
Chemin vers votre bannière (de n'importe quel format d'image qui soit supporté par une balise HTML img). Il peut être n'importe où, même distant. Cette image ne sera utilisé que pour les balises OpenGraph à moins que vous ne décidiez de l'utiliser pour autre chose.

Clé exif
Valeur boolean
Affiche ou non les métadonnées EXIF de vos photos sur les billets. Si à true seules les métadonnées existantes dans la photo seront affichées.

Clé tags
Valeur boolean
Affiche ou non les tags appliquées aux photos sur les billets.

Clé social
Valeur Clé (String): Valeur (String)
Seuls les réseaux sociaux avec un lien de profil renseigné seront affichés.
À noter que si besoin vous pouvez ajouter vos propres réseaux sociaux qui n'existe pas dans la liste par défaut mais pour faire ça vous aurez besoin d'ajouter son propre icône SVG dans le dossier public/img/sprite et le nommer exactement comme la clé définie ici.

Clé links
Valeur Clé (String): Valeur (String)
Si vous voulez afficher des liens externes dans le menu de navigation, saisissez le label (texte qui apparaitra) et l'URL de ce lien.

Une fois le tout configuré comme vous le souhaitez, il sera temps de créer vos pages.

Création de vos pages #

Toutes les pages que vous allez créer se trouveront dans le dossier content à la racine du projet.

Il y a déjà du contenu exemple dans ce dossier comme vous le verrez et vous pourrez les supprimer le moment venu mais certains dossiers et fichiers ne devrait pas être touchés ni déplacés (à moins que vous sachiez ce que vous faites), ce sont :

Tout le reste est là pour vous donner des exemples.

Créer une page indépendante #

Un exemple existe déjà, c'est celui du about.md que vous pouvez garder et modifier ou bien le supprimer et faire autre chose à votre sauce.

Vous pourrez voir dans ce fichier comment créer des pages indépendantes.

---
layout: layouts/page.njk
eleventyNavigation:
key: About
order: 1
override:tags: ["pages"]
title: Hello, I'm the photographer

---

[…]

Il vous faudra :

Ces métadonnées entre --- représentent ce qu'on appelle le frontmatter et c'est bien tout ce que c'est, des métadonnées.

Tout le reste après ça est du Markdown tout ce qu'il y a de plus normal.

Créer un billet #

Il est peut être temps de faire enfin des billets avec vos photos.
Mais d'abord parlons structure.

Comme vous le constaterez avec les exemples, chaque billet ressemble à quelque chose comme ça :

├── content
│   ├── mon-titre-de-billet
│   │   ├── index.md
│   │   ├── photo.jpg

Cette structure est plus conseillée qu'obligatoire, dans les faits rien ne vous oblige à faire ça et vous pourriez tout faire à plat à la racine de content ou dans une autre structure mais ça deviendrait vite bordélique et/ou ça vous demanderait plus de travail ainsi que de la configuration à changer au final. C'est pourquoi je vous conseille de garder cette structure à moins que vous sachiez ce que vous faites encore une fois.

Mais mettons que vous suiviez cette recommandation, le nom du dossier sera in fine l'URL de votre billet. Personnellement je préfère mettre le titre en minuscule avec des - à la place des espaces, je trouve ça plus joli à voir mais rien ne vous y oblige.
Ensuite le nom du fichier markdown .md importe peu, je le nomme toujours index.md par soucis de simplicité.
Enfin pour la photo, là aussi le nom importe peu mais il est plus sage de tout le temps la nommer de la même façon pour éviter de se tromper pour une raison que l'on va voir tout de suite.

Comme pour les pages indépendantes, nous allons avoir du frontmatter dans ces fichiers index.md avec différentes métadonnées à renseigner.

---
title: Portrait
date: 2023-09-01
photo: photo.jpg
photo_alt: Portrait de ma mère
tags:
- portrait

---

Encore une fois, tout ce qui sera écrit en markdown après ce frontmatter apparaitra sur le billet aussi.

Si vous avez activé les options exif et/ou tags le contenu de vos billets apparaitra après ces éléments dans la page.

Si vous avez tout rempli correctement vous devriez être en mesure de voir vos billets et pages indépendantes sur http://localhost:8080/

Une fois tous vos billets et pages créés et que vous êtes satisfait du résultat, il est temps de publier tout ça, mais avant n'oubliez pas de supprimer les pages et billets exemples, ça ferait tâche.

Déploiement #

Pour ce qui est du déploiement, vous aurez forcément besoin d'un hébergeur sans avoir besoin de grand chose d'installé dessus non plus.
Comme pour le développement local, vous n'aurez finalement besoin que de Node >16 et c'est tout.

Il existe bien des façons de faire de l'auto-déploiement avec git mais je ne vais pas en parler parce que ça devient un poil plus pointu en plus d'être probablement différent selon votre hébergeur.

Sachez juste que ce que Eleventy génère est un site statique, donc en gros juste du HTML/CSS/JS et pour obtenir ce site statique il vous faut lancer la commande :

cd mon-portfolio
npm run build

Cette commande de build est aussi lancée via un npm run start mais pour être sûr que tout est propre il est plus sage de lancer le build une fois que tout est fini.

Une fois le build fait vous pouvez retrouver votre site dans le dossier _site à la racine du projet. C'est ce que vous devez absolument avoir sur votre serveur d'hébergeur et c'est sur ce dossier que doit pointer votre nom de domaine. Donc configurez en conséquence dans l'administration de votre hébergeur.

Quant à la manière d'obtenir et transférer ces fichiers générés…

Et la suite dans tout ça ? #

Ce projet étant un starter kit, comprendre juste un outil de démarrage de projet, les mises à jour des dépendances (comme Eleventy et ses plugins par exemple) vous incombent. De la même manière si des évolutions ou bugfix apparaissent sur le dépôt Github ce sera à vous de vous débrouiller pour mettre à jour les corrections ou évolutions sur votre propre projet.
Toutes les modifications seront bien visibles sur Github dans tous les cas.

N'hésitez pas à me le faire savoir si vous vous retrouvez confronté à un bug ou si vous aimeriez rajouter des fonctionnalités. Je n'ai fait que ce qui m'intéressait personnellement mais je suis ouvert à toute proposition d'ajout d'autres fonctionnalités.


WebMentions

Partages :
  • avatar de Nicolas Hoizey
  • avatar de Bob Monsour
  • avatar de Benoît Launay
  • avatar de Kazuky Akayashi
  • avatar de Anis
  • avatar de ISKAN
Likes :
  • avatar de Benoît Launay
  • avatar de Nicolas Lœuillet
  • avatar de Kazuky Akayashi
  • avatar de Marmous
  • avatar de ManiSeb
Commentaires :

Lire d'autres billets