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. Veja exemplos de sites do GitHub Pages na coleção de exemplos do GitHub Pages.
Para começar, confira Criar um site do GitHub Pages.
Os proprietários da organização podem desativar a publicação de sites GitHub Pages nos repositórios da organização. Para saber mais, confira Gerenciar a publicação dos sites do 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. Os sites de usuário e organização estão conectados a uma conta específica em sua instância do GitHub Enterprise Server.
Para publicar um site de usuário, você precisa criar um repositório de propriedade da sua conta pessoal chamado <username>.<hostname>. Para publicar um site da organização, você precisa criar um repositório de propriedade de uma organização chamado <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 organização ou de uma conta pessoal, são ilimitados.
A URL em que o site estará disponível depende da habilitação do isolamento do subdomínio no sua instância do GitHub Enterprise Server.
| Tipo de site | Isolamento de subdomínio habilitado | Isolamento de subdomínio desabilitado |
|---|---|---|
| Usuário | http(s)://pages.<hostname>/<username> | http(s)://<hostname>/pages/<username> |
| Organização | http(s)://pages.<hostname>/<organization> | http(s)://<hostname>/pages/<organization> |
| Site de projeto de propriedade de uma conta pessoal | http(s)://pages.<hostname>/<username>/<repository>/ | http(s)://<hostname>/pages/<username>/<repository>/ |
| Site de projeto de propriedade da conta da organização | http(s)://pages.<hostname>/<orgname>/<repository>/ | http(s)://<hostname>/pages/<orgname>/<repository>/ |
Para obter mais informações, confira Habilitar isolamento de subdomínio ou entre em contato com o administrador do site.
Publicar fontes para sites do GitHub Pages
Warning
Se o administrador do site tiver habilitado Páginas Públicas, sites GitHub Pages estarão disponíveis publicamente na Internet, mesmo que o repositório do site seja privado ou interno. Se você tiver dados confidenciais no repositório do seu site, poderá removê-los antes de publicá-los. Para obter mais informações, confira "Configurar o GitHub Pages para a sua empresa" e "Sobre repositórios."
Você pode publicar seu site quando as alterações são enviadas por push para um branch específico ou você pode escrever um fluxo de trabalho do GitHub Actions para publicar seu site. Para usar o GitHub Actions como uma fonte de publicação de GitHub Pages, um administrador do site precisa habilitar o GitHub Actions para GitHub Enterprise Server. Para obter mais informações, confira "Habilitar GitHub Actions para o GitHub Enterprise Server".
Se você não precisar de nenhum controle sobre o processo de build do seu site, recomendamos que você publique seu site quando as alterações forem enviadas por push para um branch específico. Você pode especificar qual branch e pasta usar como fonte de publicação. O branch de origem pode ser qualquer branch em seu repositório, e a pasta de origem pode ser a raiz do repositório (/) no branch de origem ou uma pasta /docs no branch de origem. Sempre que as alterações forem enviadas por push para o branch de origem, as alterações na pasta de origem serão publicadas em seu site do GitHub Pages.
Se você deseja usar um processo de build diferente do Jekyll ou não quer que um branch dedicado mantenha seus arquivos estáticos compilados, recomendamos que você escreva um fluxo de trabalho do GitHub Actions para publicar seu site. GitHub Enterprise Server oferece modelos de fluxo de trabalho iniciais para cenários comuns de publicação para ajudar a escrever seu fluxo de trabalho.
Para saber mais, confira Configurar uma fonte de publicação para o 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.
Se você usar um processo de build ou um gerador de site estático diferente do Jekyll, poderá escrever um GitHub Actions para criar e publicar seu site. O GitHub Enterprise Server fornece modelos de fluxo de trabalho para vários geradores de site estático. Para saber mais, confira Configurar uma fonte de publicação para o site do GitHub Pages.
Se você publicar seu site de um branch de origem, GitHub Pages usará o Jekyll para criar seu site por padrão. Se você quiser usar um gerador de site estático diferente do Jekyll, recomendamos que você escreva um GitHub Actions para criar e publicar seu site. Caso contrário, desabilite o processo de build 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 compilar seu site localmente.
O GitHub Pages não aceita linguagens de servidor como PHP, Ruby ou Python.
Limites para o uso de GitHub Pages
O GitHub Pages não foi projetado nem tem permissão para ser usado como um serviço de hospedagem gratuita na Web para administrar sua empresa online, seu site de comércio eletrônico ou qualquer outro site desenvolvido principalmente para facilitar transações comerciais ou fornecer SaaS (software como serviço) comercial. 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.
Além disso, seu uso do GitHub Pages está sujeito aos Termos de Serviço do GitHub, incluindo as restrições relativas a esquemas do tipo "enriqueça rápido", conteúdo sexualmente obsceno e atividade ou conteúdo violento ou ameaçador.
Exercícios educacionais
O uso do GitHub Pages para criar uma cópia de um site existente como um exercício de aprendizagem não é proibido. No entanto, além de cumprir os Termos de Serviço do GitHub, você deve escrever o código, o site não deve coletar quaisquer dados do usuário e você deve incluir um aviso de isenção de responsabilidade de destaque no site indicando que o projeto não está associado ao original e foi criado apenas para fins educacionais.
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.
- As implantações de GitHub Pages terão tempo limite se levarem mais de 10 minutos.
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 MIME compatíveis é gerada com base no 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, confira as diretrizes de contribuição do mime-db.
Leitura adicional
- GitHub Pages no GitHub Skills
- Pontos de extremidade da API REST para repositórios