Cette version de GitHub Enterprise Server ne sera plus disponible le 2026-03-17. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.

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.

Platform navigation

Dans cet article

Anyone with read permissions for a repository can test a GitHub Pages site locally.

Prerequisites

Before you can use Jekyll to test a site, you must:

We recommend using Bundler to install and run Jekyll. Bundler manages Ruby gem dependencies, reduces Jekyll build errors, and prevents environment-related bugs. To install Bundler:

  1. Install Ruby. For more information, see Installing Ruby in the Ruby documentation.
  2. Install Bundler. For more information, see Bundler.

Conseil

If you see a Ruby error when you try to install Jekyll using Bundler, you may need to use a package manager, such as RVM or Homebrew, to manage your Ruby installation. For more information, see Troubleshooting in the Jekyll documentation.

Building your site locally

  1. Open TerminalTerminalGit Bash.

  2. Navigate to the publishing source for your site. For more information, see Configuring a publishing source for your GitHub Pages site.

  3. Run bundle install.

  4. Run your Jekyll site locally.

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

    Remarque

    • If you've installed Ruby 3.0 or later (which you may have if you installed the default version via Homebrew), you might get an error at this step. That's because these versions of Ruby no longer come with webrick installed.

      To fix the error, try running bundle add webrick, then re-running bundle exec jekyll serve.

    • If your _config.yml file's baseurl field contains your GitHub repository's link, you can use the following command when building locally to ignore that value and serve the site on localhost:4000/:

      bundle exec jekyll serve --baseurl=""

  5. To preview your site, in your web browser, navigate to http://localhost:4000.

Updating the GitHub Pages gem

Remarque

While the github-pages gem remains supported for some workflows, GitHub Actions is now the recommended approach for deploying and automating GitHub Pages sites.

Jekyll is an active open source project that is updated frequently. If the github-pages gem on your computer is out of date with the github-pages gem on the GitHub Pages server, your site may look different when built locally than when published on GitHub. To avoid this, regularly update the github-pages gem on your computer.

  1. Open TerminalTerminalGit Bash.
  2. Update the github-pages gem.
    • If you installed Bundler, run bundle update github-pages.
    • If you don't have Bundler installed, run gem update github-pages.

Further reading