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.

Sobre o GitHub Pages

Você pode usar o GitHub Pages para hospedar um site sobre si mesmo, sua organização ou seu projeto diretamente de um repositório do GitHub.

GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."

Neste artigo

Sobre o GitHub Pages

O GitHub Pages é um serviço de hospedagem de site estático que usa arquivos HTML, CSS e JavaScript diretamente de um repositório no GitHub e, como opção, executa os arquivos por meio de um processo e publica um site. Você pode ver exemplos de sites do GitHub Pages na coleção de exemplos do GitHub Pages.

É possível hospedar seu site no domínio github.io do GitHub ou no seu próprio domínio personalizado. Para obter mais informações, consulte "Usar um domínio personalizado com o GitHub Pages".

Para começar, consulte "Criar um site do GitHub Pages".

Tipos de site do GitHub Pages

Há três tipos de site do GitHub Pages: projeto, usuário e organização. Os sites de projeto são conectados a um projeto específico hospedado no GitHub, como uma biblioteca do JavaScript ou um conjunto de receitas. Os sites de usuário e organização são conectados a uma conta específica do GitHub.

Os sites de usuário e organização são sempre publicados de um repositório chamado <user>.github.io ou <organization>.github.io. A menos que você esteja usando um domínio personalizado, os sites de usuário e organização estarão disponíveis em http(s)://<username>.github.io ou http(s)://<organization>.github.io.

Os arquivos de origem de um site de projeto são armazenados no mesmo repositório que o respectivo projeto. A menos que você esteja usando um domínio personalizado, os sites de projeto estarão disponíveis em http(s)://<user>.github.io/<repository> ou http(s)://<organization>.github.io/<repository>.

Para obter mais informações sobre como os domínios personalizados afetam o URL do seu site, consulte "Sobre domínios personalizados e GitHub Pages".

Você pode criar apenas um site de usuário ou organização para cada conta do GitHub. Os sites de projeto, sejam eles de uma conta de organização ou de usuário, são ilimitados.

Observação: os repositórios que usam o esquema de nomenclatura <user>.github.com herdado ainda são publicados, mas os visitantes serão redirecionados de http(s)://<username>.github.com para http(s)://<username>.github.io. Se ambos os repositórios, <user>.github.com e <user>.github.io, existirem, somente o repositório <user>.github.io será publicado.

Publicar fontes para sites do GitHub Pages

A fonte de publicação para seu site do GitHub Pages é o branch ou a pasta onde os arquivos de origem do seu site são armazenados. Todos os sites têm uma fonte de publicação padrão, e os sites de projeto têm fontes adicionais de publicação disponíveis.

Warning: GitHub Pages sites are publicly available on the internet, even if their repositories are private. If you have sensitive data in your site's repository, you may want to remove it before publishing.

A fonte de publicação padrão para sites de usuário e organização é o branch master. Se o repositório para o site de usuário ou organização tiver um branch master, seu site será publicado automaticamente a partir desse branch. Não é possível escolher uma fonte de publicação diferente para sites de usuário ou organização.

A fonte de publicação padrão para um site de projeto é o branch gh-pages. Se o repositório para seu site de projeto tiver um branch gh-pages, seu site será publicado automaticamente a partir desse branch.

Os sites de projeto também podem ser publicados do branch master ou de uma pasta /docs no branch master. Para publicar o site de uma dessas fontes, é preciso configurar uma fonte de publicação diferente. Para obter mais informações, consulte "Configurar uma fonte de publicação para seu site do GitHub Pages".

Se você escolher a pasta /docs no branch master como a fonte de publicação, o GitHub Pages lerá tudo a ser publicado no seu site, inclusive o arquivo CNAME, na pasta /docs. Por exemplo, quando você edita o domínio personalizado usando as configurações do GitHub Pages, o domínio personalizado grava em /docs/CNAME. Para obter mais informações sobre arquivos CNAME, consulte "Gerenciar um domínio personalizado para seu site do GitHub Pages".

Geradores de site estáticos

O GitHub Pages publica qualquer arquivo estático do qual você faz push no repositório. É possível criar seus próprios arquivos estáticos ou usar um gerador de site estático para que ele crie o site para você. Também pode personalizar seu próprio processo de criação localmente ou em outro servidor. É recomendável usar o Jekyll, um gerador de site estático com suporte integrado para GitHub Pages e um processo de compilação simplificado. Para obter mais informações, consulte "Sobre o GitHub Pages e o JJekyll".

O GitHub Pages usará o Jekyll para criar seu site por padrão. Se quiser usar um gerador de site estático diferente do Jekyll, desabilite o processo de compilação do Jekyll criando um arquivo vazio chamado .nojekyll na raiz da fonte de publicação e siga as instruções do gerador de site estático para criar seu site localmente.

O GitHub Pages não aceita linguagens de servidor como PHP, Ruby ou Python.

Diretrizes para usar o GitHub Pages

  • Os sites do GitHub Pages criados após 15 de junho e que usam domínios do github.io são disponibilizados por HTTPS. Se você criou seu site ante de 15 de junho de 2016, é possível habilitar o suporte ao HTTPS para tráfego no seu site. Para obter mais informações, consulte "Proteger seu GitHub Pages com HTTPS".

  • Os sites do GitHub Pages não devem ser usados para transações confidenciais, como envio de senhas ou números de cartão de crédito.

  • O uso que você faz do GitHub Pages está sujeito aos Termos de serviço do GitHub, inclusive a proibição de revenda.

Limites de uso

Os sites do GitHub Pages estão sujeitos ao seguintes limites de uso:

  • Os repositórios de origem do GitHub Pages têm um limite recomendado de 1 GB. Para obter mais informações, consulte "Qual é a minha cota de disco?"

  • Os sites do GitHub Pages publicados não podem ter mais de 1 GB.

  • Os sites do GitHub Pages têm um limite flexível de largura de banda de 100 GB por mês.

  • Os sites do GitHub Pages têm um limite flexível de 10 compilações por hora.

Se o seu site exceder essas cotas de uso, talvez não possamos atender a ele ou você receba um e-mail formal do Suporte do GitHub or Suporte do GitHub Premium sugerindo estratégias para reduzir o impacto do site em nossos servidores, como colocar uma rede de distribuição de conteúdo (CDN, Content Distribution Network) de terceiros na frente do site, usar outros recursos do GitHub, como versões, ou migrar para outro serviço de hospedagem que possa atender melhor às suas necessidades.

Usos proibidos

O GitHub Pages não foi projetado e nem tem permissão para ser usado como um serviço de hospedagem gratuita na web, capaz de administrar sua empresa online, seu site de comércio eletrônico ou qualquer outro site desenvolvido principalmente para facilitar transações comerciais ou fornecer software comercial como um serviço (SaaS).

Além disso, os sites do GitHub Pages não devem apresentar:

  • Conteúdo ou atividade ilegal ou proibido por nossos Termos de Serviço ou pelas Diretrizes da Comunidade;
  • Atividade ou conteúdo violento ou ameaçador
  • Excesso de atividade automatizada em massa (spam, por exemplo)
  • Atividade que comprometa serviços ou usuários do GitHub
  • Esquemas para enriquecer rapidamente
  • Conteúdo sexual obsceno
  • Conteúdo que deturpe sua identidade ou a finalidade do site

Caso não tenha certeza se o seu uso ou o uso previsto se enquadra nessas categorias, entre em contato com o Suporte do GitHub or Suporte do GitHub Premium.

Tipos de MIME no GitHub Pages

Um tipo de MIME é um header que um servidor envia a um navegador, fornecendo informações sobre a natureza e o formato dos arquivos que o navegador solicitou. O GitHub Pages aceita mais de 750 tipos de MIME entre milhares de extensões de arquivo. A lista de tipos de MIME compatíveis é gerada do projeto mime-db.

Embora não seja possível especificar tipos de MIME personalizados por arquivo ou repositório, você pode adicionar ou modificar tipos de MIME para uso no GitHub Pages. Para obter mais informações, consulte as diretrizes de contribuição do mime-db.

Leia mais

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato