Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Criar um site do GitHub Pages

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

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. Para obter mais informações, consulte os "produtos do GitHub".

Observação: Os proprietários da organização podem restringir a publicação de sites de GitHub Pages de repositórios pertencentes à organização. Para obter mais informações, consulte "Gerenciar a publicação de sites de GitHub Pages".

Criar um repositório para seu site

Se o seu site for um projeto independente, você pode criar um novo repositório para armazenar o código-fonte do seu site. If your site is associated with an existing project, you can add the source code to that project's repository, in a /docs folder on the default branch or on a different branch. For example, if you're creating a site to publish documentation for a project that's already on GitHub, you may want to store the source code for the site in the same repository as the project.

If the account that owns the repository uses GitHub Free or GitHub Free for organizations, the repository must be public.

Se você deseja criar um site em um repositório existente, pule para a seção "Criar o seu site.

  1. No canto superior direito de qualquer página, use o menu suspenso e selecione Novo repositório. Menu suspenso com a opção de criar um novo repositório
  2. Use o menu suspenso Proprietário e selecione a conta que você deseja que seja proprietária do repositório. Menu suspenso Owner (Proprietário)
  3. Digite um nome para o repositório e uma descrição opcional. Se você estiver criando um site de usuário ou organização, o seu repositório deve ser denominado <user>.github.io ou <organization>.github.io. If your user or organization name contains uppercase letters, you must lowercase the letters. Para obter mais informações, consulte "Sobre GitHub Pages". Campo Create repository (Criar repositório)
  4. Escolha uma visibilidade do repositório. Para obter mais informações, consulte "Sobre repositórios". Botões de opção para selecionar a visibilidade do repositório
  5. Selecione Initialize this repository with a README (Inicializar este repositório com um README). Caixa de seleção Initialize this repository with a README (Inicializar este repositório com um README)
  6. Clique em Create Repository (Criar repositório). Button to create repository

Criar seu site

Antes de criar seu site, você deve ter um repositório para seu site no GitHub. Se você não estiver criando o site em um repositório existente, consulte "Criar um repositório para o site".

Aviso: GitHub Pages sites are publicly available on the internet, even if the repository for the site is private. If you have sensitive data in your site's repository, you may want to remove the data before publishing. Para obter mais informações, consulte "Sobre repositórios".

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

  2. Decide which publishing source you want to use. For more information, see "About GitHub Pages."

  3. Se a fonte de publicação que você escolheu já existe, navegue até ela. Caso contrário, crie a fonte de publicação.

  4. Na raiz da fonte de publicação, crie um novo arquivo chamado index.md com o conteúdo que você deseja exibir na página principal do seu site.

    Dica: se index.html estiver presente, ele será usado ao invés de index.md. Se nem index.html nem index.md estiverem presentes, será usado README.md.

  5. Configure a sua fonte de publicação. Para obter mais informações, consulte "Configurar uma fonte de publicação para seu site do GitHub Pages".

  6. No nome do seu repositório, clique em Configurações. Botão de configurações do repositório

  7. In the "Code and automation" section of the sidebar, click Pages.

  8. Para ver seu site publicado, em "GitHub Pages", clique na URL do seu site. URL do seu site publicado

    Observação: podem ser necessários até 10 minutos para que as alterações no site sejam publicadas após o push delas no GitHub. If you don't see your GitHub Pages site changes reflected in your browser after an hour, see "About Jekyll build errors for GitHub Pages sites."

  9. If your GitHub Pages site is built from a public repository, it is built and deployed with a GitHub Actions workflow run unless you've configured your GitHub Pages site to use a different CI tool. For more information about how to view the workflow status, see "Viewing workflow run history."

Note: GitHub Actions workflow runs for your GitHub Pages sites are in public beta for public repositories and subject to change. GitHub Actions workflow runs are free for public repositories.

Note: If your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source.

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 novo ficará 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 obter mais informações, consulte "Adicionar um tema ao site do GitHub Pages com o seletor de temas".

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 obter mais informações, consulte "Sobre o GitHub Pages e o JJekyll".

Leia mais