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 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".
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, 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 Enterprise.
Para publicar um site de usuário, você deve criar um repositório pertencente à sua conta de usuário que se chama <user>.<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ê pode criar apenas um site de usuário ou organização para cada conta do GitHub Enterprise. 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 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>/<repository>/ | http(s)://<hostname>/pages/<username>/<repository>/ | Organização | http(s)://pages.<hostname>/<organization>/<repository>/ | http(s)://<hostname>/pages/<organization>/<repository>/ | Site de projeto pertencente a uma conta de usuário | http(s)://pages.<hostname>/<username>/<repository>/ | http(s)://<hostname>/pages/<username>/<repository>/ Site de projeto pertencente a uma conta de 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 contate o administrador do site.
Publicar fontes para sites do GitHub Pages
The publishing source for your GitHub Pages site is the branch and folder where the source files for your site are stored. All sites have a default publishing source, and project sites have additional publishing sources available.
Warning: If your site administrator has enabled Public Pages, 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. For more information, see "Configuring GitHub Pages on your appliance" and "About repository visibility."
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 na pasta /docs.
Você não pode publicar seu site de projeto de qualquer outro branch, mesmo que o branch padrão não seja master ou gh-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 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
- GitHub Pages em GitHub Learning Lab
- "GitHub Pages"