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
  • 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. Pour l'instant c'est utilisé pour définir le schéma JSON-LD à utiliser, mais c'est prévu dans le RSS aussi
  • date : date de création publique de l'article, correspondant à la date de première publication. Utilisée dans le RSS, le SEO et certains moteurs d'affichage.
  • description : SEO, recherche interne du site, meta-tag, RSS
  • image : RSS et partage des articles dans les réseaux sociaux (c'est ce qui fait qu'on a un jouli rendu quand on partage dans Twitter ou LinkedIn par exemple). Dimensions : entre 300x600 et 400x800.
  • 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.
  • tags : permet un classement des contenus par mots-clés.

Catégories#

Voici les valeurs possibles pour les catégories de contenus. Il est possible d'en cumuler certaines sous forme de liste ["article", "tutoriel"] :

  • article : terme générique pour tout contenu, hormis les GeoRDP.
  • contribution : pour les contenus du guide de contribution
  • 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

Exemple#

Exemple pour la GeoRDP de Noël 2020 :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
---
title: "Revue de presse du 25 décembre 2020"
authors:
    - Geotribu
categories:
    - revue de presse
date: 2020-12-25 14:20
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
---

Dernière mise à jour: 6 octobre 2021
Créé: 5 janvier 2021
Contributions à cette page : Julien Moura (82.67%), Florian Boret (17.33%)

Ce contenu est sous licence Creative Commons BY-NC-SA 4.0 International


Commentaires

Une version minimale de la syntaxe markdown est acceptée pour la mise en forme des commentaires.
Propulsé par Isso.
Retour en haut de la page