Définition d’un processeur Markdown pour votre site GitHub Pages à l’aide de Jekyll

Vous pouvez choisir un processeur Markdown pour déterminer comment Markdown est rendu sur votre site GitHub Pages.

Qui peut utiliser cette fonctionnalité ?

GitHub Pages est disponible dans les référentiels publics avec GitHub Free et GitHub Free pour les organisations, et dans les référentiels publics et privés avec GitHub Pro, GitHub Team, GitHub Enterprise Cloud et GitHub Enterprise Server. Pour plus d’informations, consultez plans de GitHub.

Remarque

Bien que la gemme github-pages soit toujours pris en charge pour certains workflows, GitHub Actions est désormais l'approche recommandée pour déployer et automatiser les sites GitHub Pages.

Les personnes disposant d’autorisations en écriture sur un dépôt peuvent définir le processeur Markdown pour un site GitHub Pages.

GitHub Pages supporte deux processeurs Markdown : kramdown et le propre processeur Markdown de GitHub, qui est utilisé pour rendre GitHub Flavored Markdown (GFM) dans GitHub. Pour plus d’informations, consultez « À propos de l’écriture et de la mise en forme sur GitHub ».

Vous pouvez utiliser le Markdown enrichi de GitHub avec l’un ou l’autre des processeurs.

  1. Dans GitHub, accédez au dépôt de votre site.

  2. Dans votre dépôt, accédez au fichier _config.yml.

  3. En haut à droite de la vue de fichier, cliquez sur pour ouvrir l’éditeur de fichier.

    Capture d’écran d’un fichier. Dans l’en-tête, un bouton avec une icône de crayon est indiqué en orange foncé.

    Remarque

    Au lieu d'éditer et de valider le fichier en utilisant l'éditeur de fichiers par défaut, vous pouvez choisir d'utiliser l'éditeur de code de github.dev en sélectionnant le menu déroulant et en cliquant sur github.dev. Vous pouvez également cloner le référentiel et modifier le fichier localement via GitHub Desktop en cliquant sur GitHub Desktop .

    Capture d’écran d’un fichier. Dans l’en-tête, une icône de triangle orientée vers le bas est indiquée en orange foncé.

  4. Recherchez la ligne qui commence par markdown: et remplacez la valeur par kramdown ou GFM. La ligne complète devrait indiquer markdown: kramdown ou markdown: GFM.

  5. Cliquez sur Commiter les changements.

  6. Dans le champ de message de validation, tapez un message de validation court et descriptif qui indique la modification que vous avez apportée au fichier. Vous pouvez attribuer la validation à plusieurs auteurs dans le message de validation. Pour plus d’informations, consultez « Création d'un commit avec plusieurs auteurs ».

  7. Si vous avez plusieurs adresses e-mail associées à votre compte sur GitHub, cliquez sur le menu déroulant d’adresses e-mail et sélectionnez l’adresse e-mail à utiliser comme adresse e-mail de l’auteur Git. Seules les adresses e-mail vérifiées apparaissent dans ce menu déroulant. Si vous avez activé la confidentialité de l’adresse e-mail, le mode sans réponse sera utilisé par défaut pour l’adresse e-mail de l’auteur de commit. Pour plus d’informations sur la forme exacte que l’adresse e-mail sans réponse peut prendre, consultez Définition de votre adresse e-mail de commit.

    Capture d’écran d’une demande de tirage GitHub montrant un menu déroulant avec des options permettant de choisir l’adresse e-mail de l’auteur du commit. octocat@github.com est sélectionné.

  8. Sous les champs de message de commit, choisissez si vous souhaitez ajouter votre commit à la branche actuelle ou à une nouvelle branche. Si votre branche actuelle est la branche par défaut, vous devez choisir de créer une branche pour votre validation, puis de créer une demande de tirage (pull request). Pour plus d’informations, consultez « Création d’une pull request ».

    Capture d’écran d’une demande de tirage GitHub montrant une case d’option permettant de commiter directement dans la branche main ou de créer une branche. Une nouvelle branche est sélectionnée.

  9. Cliquez sur Valider les modifications ou Proposer des modifications.

Pour aller plus loin