Esta versão do GitHub Enterprise Server será descontinuada em 2026-03-17. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Testando seu site de páginas GitHub localmente com o Jekyll

Você pode criar o site do GitHub Pages localmente para visualizar e testar as alterações nele.

Quem pode usar esse recurso?

O GitHub Pages está disponível em repositórios públicos com o GitHub Free e o GitHub Free para organizações, e em repositórios públicos e privados com o GitHub Pro, o GitHub Team, o GitHub Enterprise Cloud e o GitHub Enterprise Server.

Platform navigation

Neste artigo

Qualquer pessoa com permissões de leitura para um repositório pode testar um site do GitHub Pages localmente.

Pré-requisitos

Antes de usar o Jekyll para testar um site, você deve:

  • Instalar Jekyll.
  • Criar um site do Jekyll. Para saber mais, confira AUTOTITLE.

Recomendamos usar o Bundler para instalar e executar o Jekyll. O Bundler gerencia as dependências do gem do Ruby, reduz os erros de compilação do Jekyll e evita erros relacionados ao ambiente. Para instalar o bundler:

  1. Instale o Ruby. Para saber mais, confira Como instalar o Ruby na documentação do Ruby.
  2. Instale o Bundler. Para saber mais, confira Bundler.

Dica

Caso você receba um erro do Ruby ao tentar instalar o Jekyll usando o Bundler, talvez seja necessário usar um gerenciador de pacotes, como o RVM ou o Homebrew, para gerenciar a instalação do Ruby. Para saber mais, confira Solução de problemas na documentação do Jekyll.

Construindo seu site localmente

  1. Abra TerminalTerminalGit Bash.

  2. Navegue até a fonte de publicação do seu site. Para saber mais, confira Configurando uma fonte de publicação para seu site GitHub Pages.

  3. Execute a .

  4. Execute o site do 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.

    Observação

    • Se você tiver instalado o Ruby 3.0 ou posterior (o que poderá acontecer se você tiver instalado a versão padrão via Homebrew), poderá receber um erro nessa etapa. Isso é porque essas versões do Ruby não vêm mais com instalado.

      Para corrigir o erro, tente executar, e depois execute novamente.

    • Se o campo baseurl do arquivo _config.yml contiver o link do repositório do GitHub, você poderá usar o seguinte comando ao construir localmente para ignorar esse valor e servir o site no localhost:4000/:

      bundle exec jekyll serve --baseurl=""

  5. Para visualizar seu site, no navegador da Web, navegue até .

Atualizar o gem do GitHub Pages

Observação

Embora o gem github-pages continue tendo suporte para alguns fluxos de trabalho, GitHub Actions agora é a abordagem recomendada para implantar e automatizar sites do GitHub Pages.

Jekyll é um projeto de código aberto ativo que é atualizado com frequência. Se o gem do computador estiver desatualizado com o gem do servidor do GitHub Pages, seu site poderá parecer diferente quando criado localmente do que quando publicado no GitHub. Para evitar isso, atualize regularmente o gem do computador.

  1. Abra TerminalTerminalGit Bash.
  2. Atualize o gem .
    • Se você instalou o Bundler, execute .
    • Se você não tiver o Bundler instalado, execute .

Leitura adicional

  • GitHub Pages na documentação do Jekyll