Skip to content

Aide à l'édition : vérificateur de l'en-tête des fichiers markdown #178

@Guts

Description

@Guts

À l'instar de nombreux outils de gestion de contenu basés sur le markdown, pas mal de fonctionnalités du site Geotribu et du workflow de publication sont liés à l'en-tête YAML : https://contribuer.geotribu.fr/guides/metadata_yaml_frontmatter/

L'idée serait donc d'ajouter une commande permettant de valider un fichier Markdown au regard des contraintes pour automatiser un peu plus la review des articles proposés.

On peut démarrer avec quelques pistes de checks à faire :

  • le nom de/s auteur/ices correspond/ent ils à un fichier team/{{trigramme}}.md
  • la date est-elle bien dans le futur
  • vérifier que le ratio de l'image, si elle est définie, soit conforme
  • vérifier que la/les catégorie/s soient parmi celles listées
  • vérifier que les tags sont dans l'ordre alphabétique

L'idéal serait que la commande sorte un texte en markdown et qu'on soit en mesure de la faire tourner dans la CI. Mais bon sur ce point, il faudrait d'abord résoudre l'ambiguité sur quel contenu est à publier et donc à checker.

À noter qu'il y a déjà des amorces dans le code avec python-frontmatter mais que c'est éparse ou à refaire. D'ailleurs, il serait peut-être plus intéressant de lire les fichiers Markdown avec Mkdocs pour utiliser le même outil.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions