Test de votre site GitHub Pages localement avec Jekyll

Vous pouvez créer votre site GitHub Pages localement pour en afficher un aperçu et tester les modifications que vous y apportez.

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

Platform navigation

Dans cet article

Toute personne disposant d’autorisations en lecture sur un dépôt peut tester un site GitHub Pages localement.

Prérequis

Avant de pouvoir utiliser Jekyll pour tester un site, vous devez :

Nous vous recommandons d’utiliser Bundler pour installer et exécuter Jekyll. Bundler gère les dépendances de gemme Ruby, réduit les erreurs de build Jekyll et empêche les bogues liés à l’environnement. Pour installer Bundler :

  1. Installer Ruby Pour plus d’informations, consultez « Installation de Ruby » dans la documentation de Ruby.
  2. Installez Bundler. Pour plus d’informations, consultez « Bundler ».

Tip

Si vous obtenez une erreur Ruby lorsque vous essayez d'installer Jekyll à l'aide de Bundler, il se peut que vous deviez utiliser un gestionnaire de paquets, tel que RVM ou Homebrew, pour gérer votre installation Ruby. Pour plus d’informations, consultez « Résolution des problèmes » dans la documentation de Jekyll.

Création de votre site en local

  1. Ouvrez TerminalTerminalGit Bash.

  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. Exécutez bundle install.

  4. Exécutez votre site Jekyll localement.

    $ bundle exec jekyll serve
> Configuration file: /Users/octocat/my-site/_config.yml
>            Source: /Users/octocat/my-site
>       Destination: /Users/octocat/my-site/_site
> Incremental build: disabled. Enable with --incremental
>      Generating...
>                    done in 0.309 seconds.
> Auto-regeneration: enabled for '/Users/octocat/my-site'
> Configuration file: /Users/octocat/my-site/_config.yml
>    Server address: http://127.0.0.1:4000/
>  Server running... press ctrl-c to stop.

    Note

    • Si vous avez installé Ruby 3.0 ou ultérieure (ce que vous pouvez avoir si vous avez installé la version par défaut via Homebrew), vous pouvez obtenir une erreur à cette étape. Ceci est dû au fait que ces versions de Ruby ne sont plus fournies avec webrick installé.

      Pour corriger l’erreur, essayez en exécutant bundle add webrick, puis en réexécutant bundle exec jekyll serve.

    • Si le champ _config.yml de votre fichier baseurl contient le lien de votre dépôt GitHub, vous pouvez utiliser la commande suivante lors de la génération locale pour ignorer cette valeur et servir le site sur localhost:4000/ :

      bundle exec jekyll serve --baseurl=""

  5. Pour voir un aperçu de votre site, dans votre navigateur web, accédez à http://localhost:4000.

Mise à jour de la gemme GitHub Pages

Jekyll est un projet open source actif qui est mis à jour fréquemment. Si la gemme github-pages sur votre ordinateur est obsolète avec la gemme github-pages sur le serveur GitHub Pages, votre site peut être différent selon s’il est créé localement ou publié sur GitHub. Pour éviter cela, mettez régulièrement à jour la gemme github-pages sur votre ordinateur.

  1. Ouvrez TerminalTerminalGit Bash.
  2. Mettez à jour la gemme github-pages.
    • Si vous avez installé Bundler, exécutez bundle update github-pages.
    • Si Bundler n’est pas installé, exécutez gem update github-pages.

Pour aller plus loin