Probar tu sitio de Páginas de GitHub localmente con Jekyll

Puedes compilar tu sitio de GitHub Pages localmente para previsualizar y probar los cambios en tu sitio.

¿Quién puede utilizar esta característica?

GitHub Pages se encuentra disponible en los repositorios públicos con GitHub Free y con GitHub Free para las organizaciones, y en los repositorios públicos y privados con GitHub Pro, GitHub Team, GitHub Enterprise Cloud, y GitHub Enterprise Server. Para más información, consulta Planes de GitHub.

GitHub Pages ahora usan GitHub Actions para ejecutar la compilación de Jekyll. Al usar una rama como origen de la compilación, se deben habilitar GitHub Actions en el repositorio si deseas usar el flujo de trabajo integrado de Jekyll. Como alternativa, si no están disponibles o se han deshabilitado GitHub Actions, agregar un archivo .nojekyll a la raíz de la rama de origen omitirá el proceso de compilación de Jekyll e implementará el contenido directamente. Para más información sobre la habilitación de GitHub Actions, consulta Administrar los ajustes de las GitHub Actions de un repositorio.

Platform navigation

En este artículo

Cualquier persona con permisos de lectura para un repositorio puede probar un sitio de GitHub Pages localmente.

Prerrequisitos

Antes de que puedas usar Jekyll para probar un sitio, debes hacer lo siguiente:

Se recomienda usar 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. Instale Ruby. Para obtener más información, consulta Instalación de Ruby en la documentación de Ruby.
  2. Instale Bundler. Para obtener más información, consulta Bundler.

Tip

Si ves un error de Ruby al intentar instalar Jekyll mediante Bundler, es posible que tengas que usar un administrador de paquetes, como RVM o Homebrew, para administrar la instalación de Ruby. Para obtener más información, consulta Solución de problemas en la documentación de Jekyll.

Construyendo tu sitio localmente

  1. Abra TerminalTerminalGit Bash.

  2. Navega a la fuente de publicación para tu sitio. Para obtener más información, vea «Configurar una fuente de publicación para tu sitio de Páginas de GitHub».

  3. Ejecute bundle install.

  4. Ejecute el sitio de Jekyll localmente.

    $ 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 has instalado Ruby 3.0 o una versión posterior (que puedes tener si instalaste la versión predeterminada mediante Homebrew), es posible que recibas un error en este paso. Esto se debe a que estas versiones de Ruby ya no incluye la instalación de webrick.

      Para corregir el error, intenta ejecutar bundle add webrick y, después, vuelve a ejecutar bundle exec jekyll serve.

    • Si el campo _config.yml del archivo baseurl contiene el vínculo del repositorio de GitHub, puede usar el siguiente comando al compilar localmente para omitir ese valor y servir el sitio en localhost:4000/:

      bundle exec jekyll serve --baseurl=""

  5. Para obtener una vista previa del sitio, en el explorador web, vaya a http://localhost:4000.

Actualizar la gema de GitHub Pages

Jekyll es un proyecto de código abierto activo que se actualiza de manera frecuente. Si la gema de github-pages de su equipo está desactualizada con respecto a la gema de github-pages del servidor de GitHub Pages, su sitio puede tener un aspecto distinto cuando se compile localmente en comparación a cuando se publique en GitHub. Para evitar esto, actualice periódicamente la gema github-pages en el equipo.

  1. Abra TerminalTerminalGit Bash.
  2. Actualice la gema github-pages.
    • Si ha instalado Bundler, ejecute bundle update github-pages.
    • Si no tiene instalado Bundler, ejecute gem update github-pages.

Información adicional