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 "produtos de 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. Se o seu site estiver associado a um projeto existente, você pode adicionar o código-fonte a esse repositório do projeto, em uma pasta de /docs no branch padrão ou em um branch diferente. Por exemplo, se você estiver criando um site para publicar a documentação de um projeto que já está em GitHub, você deverá armazenar o código-fonte para o site no mesmo repositório do projeto.

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. 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 a visibilidade do repositório." 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 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 estão disponíveis publicamente na internet por padrão, Mesmo que o repositório para o site seja privado ou interno. Se o seu site de projeto for publicado de um repositório privado ou interno pertencente a uma organização que usa GitHub Enterprise Cloud, você poderá gerenciar o controle de acesso para o site. Caso contrário, se tiver dados confidenciais no repositório do seu site, poderá remover os dados antes de publicar. For more information, see "About repository visibility" and "Changing the visibility of your GitHub Pages 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, consulte "Sobre 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.

  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. Na barra lateral esquerda, clique em Pages (Páginas). Page tab in the left-hand sidebar

  8. Opcionalmente, se você estiver publicando um site de projeto de um repositório privado ou interno pertencente a uma organização que usa GitHub Enterprise Cloud, escolha a visibilidade do seu site. Em "GitHub Pages", selecione o visibilidade de GitHub Pages no menu suspenso e, em seguida, clique em uma visibilidade. Para obter mais informações, consulte "Alterar a visibilidade do seu site de GitHub Pages". Menu suspenso para selecionar visibilidade para o seu site

  9. 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é 20 minutos para que as alterações no site sejam publicadas após o push delas no GitHub. Se você não vir suas alterações no navegador após uma hora, consulte "Sobre erros de criação do Jekyll para sites de GitHub Pages".

Observação: Se os arquivos de origem de não fez a publicação automaticamente, certifique-se de que alguém com permissões de administrador e um endereço de e-mail verificado tenha feito push para a fonte de publicação.

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 para o seu site de projeto for o branch gh-pages, e você criar um novo 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 mais informações consulte "Adicionar um tema ao site de 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

Esse documento ajudou você?Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.