Creating a GitHub Pages site

Creating a repository for your 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 para armazenar os arquivos de origem do seu site ou usar um fluxo de trabalho personalizado de GitHub Actions para criar e implantar os arquivos de origem do seu 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, use o menu suspenso e selecione Novo repositório.
2. Use o menu suspenso Proprietário e selecione a conta que você deseja que seja proprietária do repositório.
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 obter mais informações, confira "Sobre o GitHub Pages".
4. Escolha uma visibilidade do repositório. Para obter mais informações, confira "Sobre os repositórios".
5. Selecione Inicializar este repositório com um LEIAME.
6. Clique em Criar repositório.

Creating your site

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

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

2. Decida qual fonte de publicação você deseja usar. Para obter mais informações, confira "Como configurar uma fonte de publicação para o seu site do GitHub Pages."

3. Create the entry file for your site. GitHub Pages will look for an index.html, index.md, or README.md file as the entry file for your site.

   If your publishing source is a branch and folder, the entry file must be at the top level of the source folder on the source branch. For example, if your publishing source is the /docs folder on the main branch, your entry file must be located in the /docs folder on a branch called main.

   If your publishing source is a GitHub Actions workflow, the artifact that you deploy must include the entry file at the top level of the artifact. Instead of adding the entry file to your repository, you may choose to have your GitHub Actions workflow generate your entry file when the workflow runs.

4. Configure a sua fonte de publicação. Para obter mais informações, confira "Como configurar uma fonte de publicação para seu site do GitHub Pages".

5. Abaixo do nome do repositório, clique em Configurações.

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

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

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

8. Seu site GitHub Pages está integrado e foi implantado com um fluxo de trabalho GitHub Actions. Para obter mais informações, confira "Exibir o histórico de execuções de 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 obter mais informações, confira "Limites de uso, cobrança e administração".

Next steps

You can add more pages to your site by creating more new files. Each file will be available on your site in the same directory structure as your publishing source. For example, if the publishing source for your project site is the gh-pages branch, and you create a new file called /about/contact-us.md on the gh-pages branch, the file will be available at https://<user>.github.io/<repository>/about/contact-us.html.

You can also add a theme to customize your site’s look and feel. For more information, see "Adding a theme to your GitHub Pages site using Jekyll".

To customize your site even more, you can use Jekyll, a static site generator with built-in support for GitHub Pages. For more information, see "About GitHub Pages and Jekyll".

Further reading

• "Troubleshooting Jekyll build errors for GitHub Pages sites"
• "Creating and deleting branches within your repository"
• "Creating new files"