Criar um site do GitHub Pages com o Jekyll

É possível usar o Jekyll para criar um site do GitHub Pages em um repositório novo ou existente.

Quem pode usar esse recurso?

People with admin permissions for a repository can create a GitHub Pages site with Jekyll.

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.

O

Platform navigation

Neste artigo

Observação

Os proprietários da organização podem restringir a publicação de sites do GitHub Pages em repositórios pertencentes à organização. Para saber mais, confira Gerenciar a publicação dos sites do GitHub Pages para a sua organização.

Pré-requisitos

Antes de poder usar o Jekyll para criar um site do GitHub Pages, você precisa instalar o Jekyll e o Git. Para obter mais informações, confira Instalação na documentação do Jekyll e Configurar o git.

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.

Criar um repositório para seu site

Você pode criar um repositório ou escolher um repositório existente para seu site.

Se você quiser criar um site do GitHub Pages para um repositório em que nem todos os arquivos do repositório estejam relacionados ao site, você poderá configurar uma fonte de publicação para seu site. Por exemplo, você pode ter um branch e uma pasta dedicados a armazenar os arquivos de origem do site ou usar um fluxo de trabalho personalizado do GitHub Actions para criar e implantar os arquivos de origem do site. Para usar o GitHub Actions como uma fonte de publicação de GitHub Pages, um administrador do site precisa habilitar o GitHub Actions para GitHub Enterprise Server. Para saber mais, confira Habilitar GitHub Actions para o GitHub Enterprise Server.

Caso deseje criar um site em um repositório existente, vá para a seção Como criar seu site.

  1. No canto superior direito de qualquer página, selecione e clique em Novo repositório.

    Captura de tela de um menu suspenso GitHub mostrando as opções para criar novos itens. Há um item de menu "Novo repositório" com o contorno em laranja escuro.

  2. Use o menu suspenso Proprietário para selecionar a conta que deseja atribuir como proprietário do repositório.

    Captura de tela do menu Proprietário de um novo repositório do GitHub. O menu mostra duas opções, octocat e github.

  3. Digite um nome para o repositório e uma descrição opcional. Se você estiver criando um site de usuário ou de organização, seu repositório precisará ser chamado <user>.github.io ou <organization>.github.io. Se o nome do usuário ou da organização contiver letras maiúsculas, você precisará colocá-las em minúsculas. Para saber mais, confira What is GitHub Pages?.

    Captura de tela das configurações do GitHub Pages em um repositório. Há um campo de nome do repositório com o texto "octocat.github.io" e o contorno em laranja escuro.

  4. Escolha uma visibilidade do repositório. Para saber mais, confira Sobre repositórios.

Criar seu site

Para criar seu site, você precisa ter um repositório para ele no GitHub. Se não estiver criando seu site em um repositório existente, confira Como criar um repositório para seu site.

Aviso

Se o administrador do site tiver habilitado Páginas Públicas, sites GitHub Pages estarão disponíveis publicamente na Internet, mesmo que o repositório do site seja privado ou interno. Se você tiver dados confidenciais no repositório do seu site, poderá removê-los antes de publicá-los. Para saber mais, confira Configurar o GitHub Pages para a sua empresa e Sobre repositórios.

  1. Abra TerminalTerminalGit Bash.

  2. Se você ainda não tem uma cópia do seu repositório, procure o local em que deseja armazenar os arquivos de origem do seu site, substituindo PARENT-FOLDER pela pasta que deverá conter a pasta do repositório.

    cd PARENT-FOLDER

  3. Caso você ainda não tenha feito isso, inicialize um repositório Git local, substituindo REPOSITORY-NAME pelo nome do seu repositório.

    git init REPOSITORY-NAME
> Initialized empty Git repository in /REPOSITORY-NAME/.git/
# Creates a new folder on your computer, initialized as a Git repository

  4. Altere os diretórios no repositório.

    cd REPOSITORY-NAME
# Changes the working directory

  5. Decida qual fonte de publicação você deseja usar. Para saber mais, confira Configurar uma fonte de publicação para o site do GitHub Pages.

  6. Navegue até a fonte de publicação do seu site. Para saber mais, confira