Création d’un site GitHub Pages

Vous pouvez créer un site GitHub Pages dans un dépôt nouveau ou existant.

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

GitHub Pages utilise désormais GitHub Actions pour exécuter la version de Jekyll. Lorsque vous utilisez une branche comme source de votre version, GitHub Actions doit être activé dans votre référentiel si vous souhaitez utiliser le flux de travail Jekyll prédéfini. Comme alternative, si GitHub Actions n’est pas disponible ou désactivé, l’ajout d’un fichier .nojekyll à la racine de votre branche source contournera le processus de version de Jekyll et déploiera le contenu directement. Pour plus d'informations sur l'activation des GitHub Actions, consultez « Gestion des paramètres de GitHub Actions pour un dépôt ».

Dans cet article

Remarque : Les propriétaires de l’organisation peuvent restreindre la publication de sites GitHub Pages des dépôts appartenant à l’organisation. Pour plus d’informations, consultez « Gestion de la publication de sites GitHub Pages pour votre organisation ».

Création d’un dépôt pour votre site

Vous pouvez créer un dépôt ou choisir un dépôt existant pour votre site.

Si vous souhaitez créer un site GitHub Pages pour un dépôt où les fichiers du dépôt ne sont tous pas liés au site, vous pouvez configurer une source de publication pour votre site. Par exemple, vous pouvez avoir une branche et un dossier dédiés pour conserver les fichiers sources de votre site, ou vous pouvez utiliser un workflow GitHub Actions personnalisé pour générer et déployer les fichiers sources de votre site.

Si le compte propriétaire du dépôt utilise GitHub Free ou GitHub Free pour les organisations, le dépôt doit être public.

Si vous souhaitez créer un site dans un dépôt existant, passez à la section « Création de votre site ».

  1. Dans le coin supérieur droit de n’importe quelle page, sélectionnez sur , puis cliquez sur Nouveau référentiel.

    Capture d’écran d’un menu déroulant GitHub montrant les options permettant de créer des éléments. L’élément de menu « Nouveau référentiel » est souligné en orange foncé.

  2. Utilisez le menu déroulant Propriétaire pour sélectionner le compte auquel vous voulez donner la propriété du dépôt.

    Capture d’écran du menu propriétaire d’un nouveau dépôt GitHub. Le menu montre deux options, octocat et github.

  3. Tapez un nom pour votre référentiel et une description facultative. Si vous créez un utilisateur ou un site d’organisation, votre référentiel doit être nommé <user>.github.io ou <organization>.github.io. Si votre nom d’utilisateur ou d’organisation contient des lettres majuscules, vous devez mettre les lettres en minuscules. Pour plus d’informations, consultez « À propos de GitHub Pages ».

    Capture d’écran des paramètres GitHub Pages dans un dépôt. Le champ nom du dépôt contient le texte « octocat.github.io » et est délimité en orange foncé.

  4. Choisissez une visibilité de dépôt. Pour plus d’informations, consultez « À propos des dépôts ».

  5. Sélectionnez Initialize this repository with a README (Initialiser ce dépôt à l’aide d’un fichier LISEZMOI).

  6. Cliquez sur Créer le dépôt.

Création de votre site

Pour pouvoir créer votre site, vous devez avoir un dépôt pour votre site sur GitHub. Si vous ne créez pas votre site dans un dépôt existant, consultez « Création d’un dépôt pour votre site ».

Avertissement : des sites GitHub Pages sont disponibles publiquement sur Internet, même si leur dépôt est privé (si votre plan ou organisation le permet). Si vous avez des données sensibles dans le dépôt de votre site, vous pouvez les supprimer avant publication. Pour plus d’informations, consultez « À propos des dépôts ».

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

  2. Déterminez la source de publication que vous souhaitez utiliser. Pour plus d’informations, consultez « Configuration d’une source de publication pour votre site GitHub Pages ».

  3. Créez le fichier d’entrée pour votre site. GitHub Pages recherche un fichier index.html, index.md ou README.md comme fichier d’entrée pour votre site.

    Si votre source de publication est une branche et un dossier, le fichier d’entrée doit être au niveau supérieur du dossier source sur la branche source. Par exemple, si votre source de publication est le dossier /docs de la branche main, votre fichier d’entrée doit se trouver dans le dossier /docs sur une branche appelée main.

    Si votre source de publication est un workflow GitHub Actions, l’artefact que vous déployez doit inclure le fichier d’entrée au niveau supérieur de l’artefact. Au lieu d’ajouter le fichier d’entrée à votre dépôt, vous pouvez choisir de faire en sorte que votre workflow GitHub Actions génère votre fichier d’entrée quand il s’exécute.

  4. Configurez votre source de publication. Pour plus d’informations, consultez « Configuration d’une source de publication pour votre site GitHub Pages ».

  5. Sous le nom de votre dépôt, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

    Capture d’écran d’un en-tête de dépôt montrant les onglets. L’onglet « Paramètres » est mis en évidence avec un encadré orange foncé.

  6. Dans la section « Code et automatisation » de la barre latérale, cliquez sur Pages.

  7. Pour voir votre site publié, sous « GitHub Pages », cliquez sur Visiter le site.

    Capture d’écran d’un message de confirmation pour GitHub Pages répertoriant l’URL du site. À droite de l’URL, un bouton intitulé « Visiter le site » est délimité en orange foncé.

    Remarque : La publication des changements de votre site peut prendre jusqu’à 10 minutes après les avoir poussés vers GitHub. Si vous ne voyez pas vos modifications du site GitHub Pages reflétées dans votre navigateur après une heure, consultez « À propos des erreurs de build Jekyll pour les sites GitHub Pages ».

  8. Votre site GitHub Pages est construit et déployé avec un workflow GitHub Actions. Pour plus d’informations, consultez « Affichage de l’historique des exécutions de workflows ».

    Remarque : GitHub Actions est gratuit pour les référentiels publics. Les frais d’utilisation s’appliquent aux référentiels privés et internes qui dépassent l’allocation mensuelle des minutes gratuites. Pour plus d’informations, consultez « Limites d’utilisation, facturation et administration ».

Note

  • Si vous publiez à partir d’une branche et votre site n’a pas été publié automatiquement, assurez-vous qu’une personne avec des autorisations d’administrateur et une adresse e-mail vérifiée a effectué une poussée vers la source de publication.
  • Les commits envoyés par un workflow GitHub Actions qui utilise le GITHUB_TOKEN ne déclenchent pas de build GitHub Pages.

Étapes suivantes

Vous pouvez ajouter d’autres pages à votre site en créant davantage de fichiers. Chaque fichier sera disponible sur votre site dans la même structure de répertoire que celle de votre source de publication. Par exemple, si la source de publication de votre site de projet est la branche gh-pages et que vous créez un fichier appelé /about/contact-us.md sur la branche gh-pages, le fichier sera disponible dans https://<user>.github.io/<repository>/about/contact-us.html.

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

Pour personnaliser davantage votre site, vous pouvez utiliser Jekyll, un générateur de site statique avec prise en charge intégrée de GitHub Pages. Pour plus d’informations, consultez « À propos de GitHub Pages et Jekyll ».

Pour aller plus loin