Aller au contenu

L'en-tête des contenus (YAML frontmatter)#

Les sites statiques basés sur du contenu en Markdown (ou autre syntaxe flat comme rst ou autre) ont recours à un en-tête en YAML, appelé aussi YAML front-matter, qui contient des métadonnées sur la page voire carrément des instructions spécifiques à son rendu (template à utiliser, activation/désactivation de fonctionnalités...).

Le site Geotribu tire également profit de ce mécanisme.

Syntaxe#

L'en-tête est défini en haut de la page par un ensemble de clés/valeurs encadré par ---. Chaque élément a un rôle ou une réutilisation :

  • title : utilisé dans le menu de navigation de gauche, le RSS et le SEO (référencement). Cela autorise par exemple un titre différent que celui affiché dans l'article
  • subtitle : texte court affiché sous le titre dans le menu de navigation de gauche. Idéal pour indiquer qu'il s'agit d'un article au sein d'une série, ajouter un jeu de mots, etc.
  • authors : liste des contributeurs réutilisée dans les meta-tags de la page et le SEO (via schema.org)
  • categories : contient la typologie du contenu permettant des comportements adaptés. Utilisé pour classer les contenus, définir le schéma JSON-LD à utiliser et dans le flux RSS et la newsletter.
  • date : date de création publique de l'article, correspondant à la date de première publication. Format : AAAA-MM-JJ HH:mm.
  • description : texte de 155 caractères maximum (enfin, plus exacteent, le reste est tronqué) qui résume le contenu et qui est utilisé par les moteurs d'indexation et de recherche (SEO, Google, Bing...), l'index de recherche interne du site, le flux RSS et la newsletter. Voir le guide de Google sur les descriptions de contenus web.
  • image : lien vers l'image qui s'affiche lors du partage du contenu dans le flux RSS, la newsletter, les réseaux sociaux : voir la page Cartes de partage. Format : PNG ou JPG. Dimensions : entre 600x300 et 800x400.
  • legacy : stocke des informations relatives aux anciens sites Geotribu, notamment pour assurer la continuité. Uniquement pour un usage interne et pour les contenus créés avant 2020.
  • license : détermine si la licence du contenu est celle par défaut (license: default) ou non (license: none). Si la clé n'est pas renseignée, c'est la licence par défaut qui s'applique. Voir le guide Choisir sa licence.
  • robots : détermine si le contenu doit être indexé par les moteurs de recherche ou non. Par défaut: index, follow.
  • tags : liste dans l'ordre alphabétique des mots-clés qui permet le classement des contenus par mots-clés. De préférence, choisir parmi les mots-clés existants, en respectant la casse.

Catégories#

Voici les valeurs possibles pour les catégories de contenus :

  • article : terme générique pour tout contenu, hormis les GeoRDP.
  • contribution : pour les contenus du guide de contribution
  • événement : qualifie les articles présentant une conférence, un salon, etc.
  • meta : qualifie un contenu potentiellement destiné à la section "A propos" évoquant l'équipe, Geotribu, etc.
  • revue de presse : Réservé aux GeoRDP. Exclusif.
  • tutoriel : qualifie un article

Il est possible d'en cumuler certaines :

categories:
    - article
    - tutoriel

Exemple#

Exemple pour la GeoRDP de Noël 2020 :

---
title: "Revue de presse du 25 décembre 2020"
authors:
    - Geotribu
categories:
    - revue de presse
date: 2020-12-25
description: "GeoRDP du 25 décembre 2020 : la revue de presse géomatique de Geotribu pour souhaiter Joyeux Noël et bonnes fêtes !"
image: "https://cdn.geotribu.fr/img/articles-blog-rdp/merry_christmas_blender.png"
license: default
tags:
    - Cerema
    - drone
    - FIG
    - GeoRezo
    - GeoServer
    - IGN
    - Mapbox
    - Nominatim
    - open data
    - OpenLayers
    - PostGIS
---

  1. étape où un contributeur propose d'intégrer ses modifications dans le socle principal du projet. Voir la documentation de GitHub

Commentaires