Probar el sitio de GitHub Pages localmente con Jekyll

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

Prerrequisitos

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

• Instalar Jekyll
• Crear un sitio de Jekyll. Para más información, consulta Creación de un sitio de GitHub Pages con Jekyll.

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.

Construyendo tu sitio localmente

1. Abra TerminalTerminalGit Bash.

2. Navega a la fuente de publicación para tu sitio. Para más información, consulta Configuración de un origen de publicación para el sitio de GitHub Pages.

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.
   

   Nota:

   • 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 ha instalado Ruby 3.2 o posterior, es posible que vea otros errores relacionados con gemas y métodos que faltan, debido a problemas de compatibilidad con la github-pages gema. En este evento, debe instalar Ruby 3.1.x o versiones anteriores en su lugar.

   • Si el campo _config.yml del archivo baseurl contiene el enlace del repositorio de GitHub, puede usar el siguiente comando al construir localmente para ignorar 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.

Actualización de la GitHub Pages gema

Jekyll es un proyecto de código abierto activo que se actualiza con frecuencia. Si la github-pages gema de su equipo no está actualizada con la github-pages gema en el GitHub Pages servidor, el sitio puede tener un aspecto diferente cuando se compila localmente que cuando se publica 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

• GitHub Pages en la documentación de Jekyll