Criar um site do GitHub Pages

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

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. Para saber mais, confira Planos do GitHub.

O GitHub Pages agora usa o GitHub Actions para executar a compilação Jekyll. Ao usar uma ramificação como a origem da sua compilação, o GitHub Actions deverá estar habilitado em seu repositório se você quiser usar o fluxo de trabalho interno do Jekyll. Como alternativa, se o GitHub Actions não estiver disponível ou estiver desabilitado, adicionar um .nojekyll arquivo à raiz da ramificação de origem ignorará o processo de compilação do Jekyll e implantará o conteúdo diretamente. Para mais informações sobre ativar o GitHub Actions, confira Gerenciando as configurações do GitHub Actions para um repositório.

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.

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.

Se a conta que é o proprietário do repositório usar o GitHub Free ou o GitHub Free para organizações, o repositório precisará ser público.

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.

    Observação

    Se você for um conta de usuário gerenciada, só será possível publicar sites GitHub Pages de repositórios pertencentes a organizações. Para saber mais, confira What is GitHub Pages?.

  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.

  5. Selecione Inicializar este repositório com um LEIAME.

  6. Clique em Criar repositório.

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

A menos que sua empresa use Enterprise Managed Users, sites de GitHub Pages estarão disponíveis publicamente na Internet por padrão, mesmo que o repositório para o site seja privado ou interno. Você pode publicar um site de forma privada gerenciando o controle de acesso para o site. Caso contrário, se você tiver dados confidenciais no repositório do seu site, talvez queira remover os dados antes da publicação. Para saber mais, confira Sobre repositórios e Alterar a visibilidade do site do GitHub Pages.

  1. No GitHub, acesse o repositório do seu site.

  2. 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.

  3. Crie o arquivo de entrada para seu site. GitHub Pages procurará um arquivo index.html, index.md ou README.md como o arquivo de entrada do seu site.

    Se a sua fonte de publicação for um branch e uma pasta, o arquivo de entrada precisará estar no nível superior da pasta de origem no branch de origem. Por exemplo, se sua fonte de publicação for a pasta /docs no branch main, seu arquivo de entrada precisará estar localizado na pasta /docs em um branch chamado main.

    Se a fonte de publicação for um fluxo de trabalho do GitHub Actions, o artefato que você implantar precisará incluir o arquivo de entrada na parte superior do artefato. Em vez de adicionar o arquivo de entrada ao repositório, há a opção de fazer com que o fluxo de trabalho do GitHub Actions gere esse arquivo de entrada ao ser executado.

  4. Configure a sua fonte de publicação. Para saber mais, confira Configurar uma fonte de publicação para o site do GitHub Pages. 1. Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  5. Na seção "Código e automação" da barra lateral, clique em Páginas.

  6. Opcionalmente, para publicar um site de projeto de um repositório privado ou interno, escolha a visibilidade do seu site. Em "GitHub Pages", clique no menu suspenso de visibilidade e selecione público ou privado.

    Captura de tela das configurações de Páginas para um repositório. A lista suspensa de visibilidade, definida como "Private", está contornada em laranja escuro.

    Observação

    Para publicar um site do GitHub Pages de modo privado, sua organização precisa usar o GitHub Enterprise Cloud. Para obter mais informações sobre como você pode experimentar o GitHub Enterprise Cloud gratuitamente, confira Como configurar uma avaliação do GitHub Enterprise Cloud. 1. Para ver o site publicado, em "GitHub Pages", clique em Visitar site.

    Captura de tela de uma mensagem de confirmação para o GitHub Pages listando a URL do site. O botão cinza "Visit site" está contornado em laranja.

    Observação

    Poderá levar até 10 minutos para que as alterações no seu site sejam publicadas depois que você efetuar push das alterações no GitHub. Se as alterações no site de GitHub Pages não forem refletidas no navegador após uma hora, confira Sobre erros de criação do Jekyll para sites do GitHub Pages.

  7. Seu site GitHub Pages está integrado e foi implantado com um fluxo de trabalho GitHub Actions. Para saber mais, confira Visualizar o histórico de execução do fluxo de trabalho.

    Observação

    O GitHub Actions é gratuito para repositórios públicos. Os encargos de uso se aplicam a repositórios privados e internos que vão além do loteamento mensal de minutos gratuitos. Para saber mais, confira Limites de uso, cobrança e administração.

Observação

  • Se você estiver publicando por meio de um branch e o seu site não tiver sido publicado automaticamente, verifique se alguém com permissões de administrador e um endereço de email verificado efetuou um push para a fonte de publicação.
  • Commits enviados por push por um fluxo de trabalho de GitHub Actions que usa o GITHUB_TOKEN não disparam um build de GitHub Pages.

Próximas etapas

Você pode adicionar mais páginas ao seu site criando novos arquivos. Cada arquivo ficará disponível no site na mesma estrutura de diretórios que a fonte de publicação. Por exemplo, se a fonte de publicação do site de projeto for o branch gh-pages e você criar um arquivo chamado /about/contact-us.md no branch gh-pages, o arquivo estará disponível em https://<user>.github.io/<repository>/about/contact-us.html.

Também é possível adicionar um tema para personalizar a aparência do site. Para saber mais, confira Adicionar um tema ao site do GitHub Pages usando Jekyll.

Para personalizar seu site ainda mais, você pode usar o Jekyll, um gerador de site estático com suporte integrado para o GitHub Pages. Para saber mais, confira Sobre o GitHub Pages e o Jekyll.

Leitura adicional