Testar o site do GitHub Pages localmente com o Jekyll

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

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

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 o Jekyll.
Criar um site do Jekyll. Para obter mais informações, consulte "Criar um site do GitHub Pages com o Jekyll".

Recomendamos o uso do 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:

Instale o Ruby. Para obter mais informações, consulte "Instalar o Ruby" na documentação do Ruby.
Instale o Bundler. Para obter mais informações, consulte "Bundler".

Dica: se vir um erro do Ruby ao tentar instalar o Jekyll usando o Bundler, talvez você precise usar um gerenciador de pacotes, como o RVM ou Homebrew, para gerenciar a instalação do Ruby. Para obter mais informações, consulte "Solução de problemas" na documentação do Jekyll.

Criar site localmente

Abra TerminalTerminalGit Bash.
Navegue até a fonte de publicação do seu site. Para obter mais informações sobre fontes de publicação, consulte "Sobre o GitHub Pages".

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.

Para visualizar o site, navegue para http://localhost:4000 no navegador da web.

Atualizar o gem do GitHub Pages

O Jekyll é um projeto ativo de código aberto que é atualizado com frequência. Se o gem github-pages no seu computador estiver desatualizado em relação ao gem github-pages no servidor do GitHub Pages, seu site poderá ter uma aparência diferente da criada localmente quando for publicado no GitHub Enterprise Server. Para evitar isso, atualize regularmente o gem github-pages no seu computador.

Abra TerminalTerminalGit Bash.
Atualize o gem github-pages.
- Se você instalou o bundler, execute bundle update github-pages.
- Se não tiver o bundler instalado, execute gem update github-pages.