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

Fonctionnalité : validation des liens Mkdocs 1.5 #966

Merged
merged 19 commits into from
Sep 18, 2023

Conversation

Guts
Copy link
Member

@Guts Guts commented Aug 6, 2023

Cette PR ajoute la configuration pour la validation des liens (externes et internes) désormais intégrée à Mkdocs directement : https://www.mkdocs.org/user-guide/configuration/#validation

links:
  absolute_links: warn
  not_found: warn
  unrecognized_links: info
nav:
  absolute_links: ignore
  not_found: warn
  omitted_files: info

Changement des consignes de rédaction

Cela a des impacts au moment de la rédaction car jusqu'à présent on recommandait plutôt la notation de liens sous forme absolue :

  • avant :

    [forces de l'ordre](/rdp/2011/rdp_2011-12-09#openstreetmap-et-les-forces-de-lordre).
  • maintenant :

    [forces de l'ordre](../../rdp/2011/rdp_2011-12-09.md#openstreetmap-et-les-forces-de-lordre)

Avantages

  • on utilise la syntaxe de Mkdocs et on profite de la validation intégrée

  • on peut naviguer entre les contenus depuis un IDE ou GitHub

  • on profite des fonctionnalités d'autocomplétion des IDE comme VS Code :

    edition_hyperliens_vscode_autocompletion.webm

@github-actions github-actions bot added the dependencies Pull requests that update a dependency file label Aug 6, 2023
@Guts Guts self-assigned this Sep 4, 2023
@Guts Guts added the mkdocs Tout ce qui est lié au générateur de site : configuration, hooks, scripts... label Sep 4, 2023
@github-actions github-actions bot removed mkdocs Tout ce qui est lié au générateur de site : configuration, hooks, scripts... dependencies Pull requests that update a dependency file labels Sep 4, 2023
@github-actions github-actions bot added rdp Revues de presse contributeurices Contenus liés à la contribution et contributeur/ices : biographies, à propos, etc. articles Tutoriels, actualité, billet... labels Sep 18, 2023
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions github-actions bot added mkdocs Tout ce qui est lié au générateur de site : configuration, hooks, scripts... dependencies Pull requests that update a dependency file labels Sep 18, 2023
@Guts Guts marked this pull request as ready for review September 18, 2023 12:52
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@Guts Guts removed rdp Revues de presse dependencies Pull requests that update a dependency file contributeurices Contenus liés à la contribution et contributeur/ices : biographies, à propos, etc. articles Tutoriels, actualité, billet... labels Sep 18, 2023
@github-actions github-actions bot added rdp Revues de presse dependencies Pull requests that update a dependency file contributeurices Contenus liés à la contribution et contributeur/ices : biographies, à propos, etc. articles Tutoriels, actualité, billet... labels Sep 18, 2023
@github-actions

This comment has been minimized.

Guts added a commit to geotribu/site-contribuer that referenced this pull request Sep 18, 2023
@Guts
Copy link
Member Author

Guts commented Sep 18, 2023

Pour info @igeofr et @aurelienchaumet

@github-actions
Copy link
Contributor

👏 Le markdown ajouté ou modifié est impeccable ! Merci 🥇

@github-actions
Copy link
Contributor

🎉 Le site de prévisualisation pour cette PR a été généré et est disponible sous ce lien.
Commit de référence : 1739884.

@Guts Guts merged commit a2e87cb into master Sep 18, 2023
6 checks passed
@Guts Guts deleted the feature/add-mkdocs-1-5-links-validation branch September 18, 2023 15:11
@Guts Guts added enhancement Ajout ou amélioration d'une fonctionnalité and removed rdp Revues de presse dependencies Pull requests that update a dependency file contributeurices Contenus liés à la contribution et contributeur/ices : biographies, à propos, etc. articles Tutoriels, actualité, billet... labels Sep 18, 2023
@github-actions github-actions bot temporarily deployed to pr-previews September 18, 2023 15:11 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Ajout ou amélioration d'une fonctionnalité mkdocs Tout ce qui est lié au générateur de site : configuration, hooks, scripts...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant