Testing your GitHub Pages site locally with Jekyll

You can build your Páginas de GitHub site locally to preview and test changes to your site.

Páginas de GitHub se encuentra disponible en repositorios públicos con GitHub Free y GitHub Free para organizaciones, y en repositorios privados y públicos con GitHub Pro, GitHub Team, GitHub Enterprise Cloud, y Servidor de GitHub Enterprise.

Anyone with read permissions for a repository can test a Páginas de GitHub site locally.


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

Recomendamos utilizando Bundler para instalar y ejecutar Jekyll. Bundler administra las dependencias de gema de Ruby, reduce los errores de construcción de Jekyll y evita los errores relacionados con el entorno. Para instalar Bundler:

  1. Instala Ruby. Para obtener más información, consulta "Instalar Ruby" en la documentación de Ruby.
  2. Instala Bundler. Para obtener más información, visita "Bundler".

Sugerencia: si ves un error de Ruby cuando tratas de instalar Jekyll utilizando Bundler, es posible que necesites utilizar un administrador de paquete, como RVM o Homebrew, para administrar tu instalación de Ruby. Para obtener más información, consulta la sección "Solución de problemas" en la documentación de Jekyll.

Building your site locally

  1. Abre la TerminalTerminalGit Bash.
  2. Navega a la fuente de publicación para tu sitio. Para obtener más información acerca de las fuentes de publicación, consulta "Acerca de las Páginas de GitHub".
  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:
    >  Server running... press ctrl-c to stop.
  5. To preview your site, in your web browser, navigate to http://localhost:4000.

Updating the Páginas de GitHub gem

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 Páginas de GitHub server, your site may look different when built locally than when published on GitHub Enterprise. To avoid this, regularly update the github-pages gem on your computer.

  1. Abre la 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

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

O, learn how to contribute.