Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Guts opened this issue Mar 7, 2024 · 1 comment · Fixed by #184
Open

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

Guts opened this issue Mar 7, 2024 · 1 comment · Fixed by #184
Labels
enhancement New feature or request

Comments

@Guts
Copy link
Member

Guts commented Mar 7, 2024

À 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.

@Guts Guts added the enhancement New feature or request label Mar 7, 2024
@Guts
Copy link
Member Author

Guts commented Mar 15, 2024

cc @gounux si ça t'intéresse

@gounux gounux mentioned this issue Mar 17, 2024
6 tasks
@Guts Guts linked a pull request Jun 23, 2024 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant