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

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

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. In an enterprise with managed users, all GitHub Pages sites are privately published. Para obter mais informações, consulte "Alterar a visibilidade do seu site de GitHub Pages."

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

Os proprietários da organização podem desabilitar a publicação de sites do GitHub Pages nos repositórios da organização. Para obter mais informações, consulte "Gerenciar a publicação de sites de GitHub Pages para a sua organização".

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.

Para publicar um site de usuário, você deve criar um repositório pertencente à sua conta de usuário denominada <username>. ithub.io. Para publicar um site de organização, você deve criar um repositório pertencente a uma organização que se chama <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 estão disponíveis em http(s)://<username>.github.io/<repository> ou http(s)://<organization>.github.io/<repository>.

Se você publicar seu site em particularmente, a URL do seu site será diferente. Para obter mais informações, consulte "Alterar a visibilidade do seu site de GitHub Pages."

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ê só pode criar um site de usuário ou organização para cada conta em GitHub. Os sites de projeto, sejam eles de uma conta de organização ou de usuário, são ilimitados.

Publicar fontes para sites do GitHub Pages

A fonte de publicação do seu site de GitHub Pages é o branch e a pasta onde os arquivos de origem do seu site são armazenados.

Aviso: os sites de GitHub Pages estarão disponíveis publicamente na internet por padrãomwsmo 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. In an enterprise with managed users, all GitHub Pages sites are privately published. caso contrário, se você tiver dados confidenciais no repositório do seu site, você deverá remover os dados antes de publicá-los. For more information, see "About repositories" and "Changing the visibility of your GitHub Pages site."

Se existir uma fonte de publicação padrão no repositório, o GitHub Pages publicará automaticamente um site a partir dessa fonte. A fonte de publicação padrão para sites de usuário e organização é a raiz do branch-padrão do repositório. A fonte de publicação padrão para sites de projeto é a raiz do branch gh-pages.

Se você desejar manter os arquivos de origem do seu site em outro local, você poderá alterar a fonte de publicação do seu site. É possível publicar o site a partir de qualquer branch no repositório, a partir da raiz do repositório nesse branch, / ou a partir da pasta /docs nesse branch. Para obter mais informações, consulte "Configurar uma fonte de publicação para seu site do GitHub Pages".

Se você escolher a pasta /docs de qualquer branch 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.

  • Sites de GitHub Pages têm um limite de banda larga flexível 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 GitHub Support 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, GitHub não permite que GitHub Pages seja usado para certos propósitos ou atividades. Para uma lista de usos proibidos, consulte "Termos Adicionais do Produto de GitHub para GitHub Pages".

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

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.