Início rápido para o GitHub Pages

Você pode usar GitHub Pages para exibir alguns projetos de código aberto, hospedar um blogue ou até mesmo compartilhar seu currículo. Este guia ajudará você a começar a criar o seu próximo site.

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 mais informações, 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

Introdução

GitHub Pages são sites públicos hospedados e publicados por meio de GitHub. A maneira mais rápida de colocar em funcionamento é usar o seletor de temas Jekyll para carregar um tema pré-criado. Em seguida, você pode modificar o seu estilo e conteúdo de GitHub Pages.

Este guia descreverá a criação de um site de usuário em username.github.io.

Criando 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. Insira username.github.io como o nome do repositório. Substitua username pelo nome de usuário do GitHub. Por exemplo, se o nome de usuário for octocat, o nome do repositório deverá ser octocat.github.io.

    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.

  3. Escolha uma visibilidade do repositório. Para obter mais informações, confira "Sobre repositórios".

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

  5. Clique em Criar repositório.

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

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

  8. Em "Build e implantação", em "Fonte", selecione Fazer implantação de um branch.

  9. Em "Build e implantação", em "Branch", use o menu suspenso do branch e selecione uma fonte de publicação.

    Captura de tela das configurações do Pages em um repositório do GitHub. Há um menu "Nenhum" para e selecionar um branch para uma fonte de publicação com o contorno em laranja escuro.

  10. Opcionalmente, abra o arquivo README.md do seu repositório. O arquivo README.md é o local em que você escreverá o conteúdo do site. Você pode editar o arquivo ou manter o conteúdo padrão por enquanto.

  11. Acesse username.github.io para ver seu novo site. Observe que 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.

Alterando o título e a descrição

Por padrão, o título do site é username.github.io. Altere o título editando o arquivo _config.yml no repositório. Você também pode adicionar uma descrição para o seu site.

  1. Clique na guia Código do repositório.

  2. Na lista de arquivos, clique em _config.yml para abrir o arquivo.

  3. Clique em para editar o arquivo.

  4. O arquivo _config.yml já contém uma linha que especifica o tema do site. Adicione uma nova linha com title: seguida do título desejado. Adicione uma nova linha com description: seguida da descrição desejada. Por exemplo:

    theme: jekyll-theme-minimal
title: Octocat's homepage
description: Bookmark this to keep an eye on my project updates!

  5. Quando terminar de editar o arquivo, clique em Fazer commit das alterações.

Próximas etapas

Para obter mais informações sobre como adicionar mais páginas ao seu site, confira Adicionar conteúdo ao site do GitHub Pages usando o Jekyll.

Para obter mais informações sobre como configurar um site do GitHub Pages com o Jekyll, confira Sobre o GitHub Pages e o Jekyll.