Démarrage rapide pour GitHub Pages

Vous pouvez utiliser GitHub Pages pour présenter certains projets open source, héberger un blog ou même partager votre CV. Ce guide vous aidera à vous lancer dans la création de votre prochain site web.

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

Introduction

Les pages GitHub Pages sont des pages web publiques hébergées et publiées via GitHub. Le moyen le plus rapide d’être opérationnel est d’utiliser le sélecteur de thème Jekyll pour charger un thème prédéfini. Vous pouvez ensuite modifier le contenu et le style de vos pages GitHub Pages.

Ce guide vous explique les étapes de création d’un site utilisateur sur username.github.io.

Création de votre site web

  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. Entrez username.github.io comme nom du dépôt Remplacez username par votre nom d’utilisateur GitHub. Par exemple, si votre nom d’utilisateur est octocat, le nom du dépôt doit être octocat.github.io.

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

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

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

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

  6. 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é.

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

  8. Sous « Génération et déploiement », sous « Source », sélectionnez Déployer à partir d’une branche.

  9. Sous « Génération et déploiement », sous « Branche », utilisez le menu déroulant Branche et sélectionnez une source de publication.

    Capture d’écran des paramètres Pages dans un dépôt GitHub. Un menu permettant de sélectionner une branche pour une source de publication, intitulé « Aucun », est indiqué en orange foncé.

  10. Ouvrez éventuellement le fichier README.md de votre dépôt. Le fichier README.md est l’endroit où vous allez écrire le contenu de votre site. Vous pouvez modifier le fichier ou conserver le contenu par défaut pour l’instant.

  11. Accédez à username.github.io pour voir votre nouveau site web. Notez que la publication des changements de votre site peut prendre jusqu’à 10 minutes après les avoir poussés vers GitHub.

Modification du titre et de la description

Par défaut, le titre de votre site est username.github.io. Vous pouvez changer le titre en modifiant le fichier _config.yml dans votre dépôt. Vous pouvez aussi ajouter une description pour votre site.

  1. Cliquez sur l’onglet Code de votre dépôt.

  2. Dans la liste des fichiers, cliquez pour _config.yml ouvrir le fichier.

  3. Cliquez sur pour modifier le fichier.

  4. Le fichier _config.yml contient déjà une ligne qui spécifie le thème de votre site. Ajoutez une nouvelle ligne avec title: suivi du titre souhaité. Ajoutez une nouvelle ligne avec description: suivi de la description souhaitée. Par exemple :

    theme: jekyll-theme-minimal
title: Octocat's homepage
description: Bookmark this to keep an eye on my project updates!

  5. Quand vous avez terminé la modification du fichier, cliquez sur Commiter les modifications.

Étapes suivantes

Pour plus d’informations sur l’ajout de pages supplémentaires à votre site, consultez Ajout d’un thème à votre site GitHub Pages avec Jekyll.

Pour plus d’informations sur la configuration d’un site GitHub Pages avec Jekyll, consultez À propos de GitHub Pages et Jekyll.