Ajout d’un thème à votre site GitHub Pages avec Jekyll

Vous pouvez ajouter une nouvelle page ou publier sur votre site Jekyll sur 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.

Dans cet article

Les personnes disposant d’autorisations d’écriture pour un référentiel peuvent ajouter du contenu à un site GitHub Pages à l’aide de Jekyll.

À propos du contenu dans les sites Jekyll

Avant de pouvoir ajouter du contenu à un site Jekyll sur GitHub Pages, vous devez créer un site Jekyll. Pour plus d’informations, consultez « Création d’un site GitHub Pages avec Jekyll ».

Les principaux types de contenu pour les sites Jekyll sont des pages et des publications. Une page est destinée au contenu autonome qui n’est pas associé à une date spécifique, comme une page « À propos ». Le site Jekyll par défaut contient un fichier appelé about.md, qui s’affiche en tant que page sur votre site à l’adresse YOUR-SITE-URL/about. Vous pouvez modifier le contenu de ce fichier pour personnaliser votre page « À propos », et vous pouvez utiliser la page « À propos » comme modèle pour créer de nouvelles pages. Pour plus d’informations, consultez « Pages » dans la documentation de Jekyll.

Une publication est un billet de blog. Le site Jekyll par défaut contient un répertoire nommé _posts qui contient un fichier de publication par défaut. Vous pouvez modifier le contenu de cette publication et l’utiliser comme modèle pour en créer de nouvelles. Pour plus d’informations, consultez « Publications » dans la documentation de Jekyll.

Votre thème inclut les dispositions, les includes et les feuilles de style par défaut qui s’appliqueront automatiquement aux nouvelles pages et publications de votre site, mais vous pouvez remplacer n’importe laquelle de ces valeurs par défaut. Pour plus d’informations, consultez « À propos de GitHub Pages et Jekyll ».

Pour définir des variables et des métadonnées, telles qu’un titre et une mise en page, pour une page ou une publication de votre site, vous pouvez ajouter des pages liminaires YAML en haut de n’importe quel fichier Markdown ou HTML. Pour plus d’informations, consultez « Pages liminaires » dans la documentation de Jekyll.

Si vous publiez à partir d’une branche, les changements de votre site sont publiés automatiquement quand ils sont fusionnés dans la source de publication de votre site. Si vous publiez à partir d’un workflow GitHub Actions personnalisé, les changements sont publiés quand votre workflow est déclenché (généralement via une poussée vers la branche par défaut). Si vous voulez d’abord afficher un aperçu de vos changements, vous pouvez faire les changements localement au lieu de les faire sur GitHub Enterprise Server. Ensuite, testez votre site localement. Pour plus d’informations, consultez « Test de votre site GitHub Pages localement avec Jekyll ».

Ajout d’une nouvelle page à votre site

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

  2. Accédez à la source de publication pour votre site. Pour plus d’informations, consultez « Configuration d’une source de publication pour votre site GitHub Pages ».

  3. À la racine de votre source de publication, créez un fichier pour votre page appelé PAGE-NAME.md, en remplaçant PAGE-NAME par un nom de fichier explicite pour la page.

  4. Ajoutez le frontmatter YAML suivant en haut du fichier, en remplaçant PAGE-TITLE par le titre de la page et URL-PATH par un chemin d’accès souhaité pour l’URL de la page. Par exemple, si l’URL de base de votre site est https://octocat.github.io et que votre URL-PATH est /about/contact/, votre page se trouve à l’emplacement https://octocat.github.io/about/contact.

    layout: page
title: "PAGE-TITLE"
permalink: /URL-PATH

  5. Sous le frontmatter, ajoutez du contenu pour votre page.

  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’une validation avec plusieurs auteurs ».

  7. 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 demande de tirage ».

    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.

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

  9. Créez une demande de tirage pour vos changements proposés.

  10. Dans la liste « Demandes de tirage », cliquez sur la demande de tirage à fusionner.

  11. Cliquez sur Fusionner la demande de tirage. Pour plus d’informations, consultez « Fusion d’une demande de tirage ».

  12. Si vous y êtes invité, tapez un message de commit ou acceptez le message par défaut.

  13. Cliquez sur Confirmer la fusion.

  14. Si vous le souhaitez, supprimez la branche. Pour plus d’informations, consultez « Création et suppression de branches dans votre référentiel ».

Ajout d’une nouvelle publication à votre site

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

  2. Accédez à la source de publication pour votre site. Pour plus d’informations, consultez « Configuration d’une source de publication pour votre site GitHub Pages ».

  3. Accédez au répertoire _posts.

  4. Créez un fichier appelé YYYY-MM-DD-NAME-OF-POST.md, en remplaçant YYYY-MM-DD par la date de votre publication et NAME-OF-POST par le nom de votre publication.

  5. Ajoutez le frontmatter YAML suivant en haut du fichier, y compris le titre de la publication entre guillemets, la date et l’heure de la publication au format AAAA-MM-JJ hh:mm:ss -0000 et autant de catégories que vous le souhaitez pour votre publication.

    layout: post
title: "POST-TITLE"
date: YYYY-MM-DD hh:mm:ss -0000
categories: CATEGORY-1 CATEGORY-2

  6. Sous le frontmatter, ajoutez du contenu pour votre publication.

  7. 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’une validation avec plusieurs auteurs ».

  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 demande de tirage ».

    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.

  10. Créez une demande de tirage pour vos changements proposés.

  11. Dans la liste « Demandes de tirage », cliquez sur la demande de tirage à fusionner.

  12. Cliquez sur Fusionner la demande de tirage. Pour plus d’informations, consultez « Fusion d’une demande de tirage ».

  13. Si vous y êtes invité, tapez un message de commit ou acceptez le message par défaut.

  14. Cliquez sur Confirmer la fusion.

  15. Si vous le souhaitez, supprimez la branche. Pour plus d’informations, consultez « Création et suppression de branches dans votre référentiel ».

Votre publication devrait maintenant être disponible sur votre site ! Si l’URL de base de votre site est https://octocat.github.io, votre nouvelle publication se trouve à l’adresse https://octocat.github.io/YYYY/MM/DD/TITLE.html.

Étapes suivantes

Vous pouvez ajouter un thème Jekyll à votre site GitHub Pages pour personnaliser son apparence. Pour plus d’informations, consultez « Ajout d’un thème à votre site GitHub Pages avec Jekyll ».