Sobre o GitHub Pages

You can use GitHub Pages to host a website about yourself, your organization, or your project directly from a repository on your GitHub Enterprise Server instance.

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.

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 Enterprise Server 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.

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 Enterprise Server, como uma biblioteca do JavaScript ou um conjunto de receitas. User and organization sites are connected to a specific account on your GitHub Enterprise Server instance.

Para publicar um site de usuário, você deve criar um repositório pertencente à sua conta de usuário denominada <username>.<hostname>. Para publicar um site de organização, você deve criar um repositório pertencente a uma organização que se chama <organization>.<hostname>.

Os arquivos de origem de um site de projeto são armazenados no mesmo repositório que o respectivo projeto.

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

O URL onde o site estará disponível depende da habilitação do isolamento do subdomínio para o your GitHub Enterprise Server instance.

Tipo de siteIsolamento de subdomínio habilitadoIsolamento de subdomínio desabilitado
Usuário

http(s)://pages.<hostname>/<username> | http(s)://<hostname>/pages/<username> | Organization | http(s)://pages.<hostname>/<organization> | http(s)://<hostname>/pages/<organization> | Site do projeto pertencente a uma conta do usuário | http(s)://pages.<hostname>/<username>/<repository>/ | http(s)://<hostname>/pages/<username>/<repository>/ Site do projeto pertencente a uma conta da organização | http(s)://pages.<hostname>/<orgname>/<repository>/ | http(s)://<hostname>/pages/<orgname>/<repository>/

Para obter mais informações, consulte "Habilitar isolamento de subdomínio" ou entre em contato com o administrador do site.

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.

Warning: If your site administrator has enabled Public Pages, GitHub Pages sites are publicly available on the internet, even if the repository for the site is private or internal. If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "Configuring GitHub Pages for your enterprise" and "About repositories."

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 na pasta /docs.

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.

Limits on use of GitHub Pages

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

In addition, your use of GitHub Pages is subject to the GitHub Terms of Service, including the restrictions on get rich quick schemes, sexually obscene content, and violent or threatening content or activity.

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.
  • Os sites do GitHub Pages publicados não podem ter mais de 1 GB.

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.