Adicionar conteúdo ao site do GitHub Pages usando o Jekyll

É possível adicionar uma nova página ou postagem ao site do Jekyll no GitHub Pages.

Quem pode usar esse recurso?

O GitHub Pages está disponível em repositórios públicos com o GitHub Free e o GitHub Free para organizações, e em repositórios públicos e privados com o GitHub Pro, o GitHub Team, o GitHub Enterprise Cloud e o GitHub Enterprise Server. Para saber mais, confira Planos do GitHub.

O GitHub Pages agora usa o GitHub Actions para executar a compilação Jekyll. Ao usar uma ramificação como a origem da sua compilação, o GitHub Actions deverá estar habilitado em seu repositório se você quiser usar o fluxo de trabalho interno do Jekyll. Como alternativa, se o GitHub Actions não estiver disponível ou estiver desabilitado, adicionar um .nojekyll arquivo à raiz da ramificação de origem ignorará o processo de compilação do Jekyll e implantará o conteúdo diretamente. Para mais informações sobre ativar o GitHub Actions, confira Gerenciando as configurações do GitHub Actions para um repositório.

Neste artigo

Pessoas com permissões de gravação para um repositório podem adicionar conteúdo a um site do GitHub Pages usando o Jekyll.

Sobre conteúdo em sites do Jekyll

Para poder adicionar conteúdo a um site do Jekyll no GitHub Pages, você precisa criar o site do Jekyll. Para saber mais, confira Criar um site do GitHub Pages com o Jekyll.

Os principais tipos de conteúdo para sites do Jekyll são páginas e postagens. As páginas se destinam a conteúdo autônomo que não está associado a uma data específica, como uma página "Sobre". O site padrão do Jekyll contém um arquivo chamado about.md, que é renderizado como uma página no seu site em YOUR-SITE-URL/about. Você pode editar o conteúdo desse arquivo para personalizar a página "Sobre" e usá-la como um modelo para criar novas páginas. Para obter mais informações, confira Páginas na documentação do Jekyll.

As postagens são uma postagem de blog. O site padrão do Jekyll contém um diretório chamado _posts que contém um arquivo de postagem padrão. Você pode editar o conteúdo dessa postagem e usá-la como modelo para criar novas postagens. Para obter mais informações, confira Postagens na documentação do Jekyll.

O tema engloba layouts, inclusões e folhas de estilo padrão que serão aplicados automaticamente a novas páginas e postagens no site, mas é possível substituir qualquer um desses padrões. Para saber mais, confira Sobre o GitHub Pages e o Jekyll.

Para definir variáveis e metadados, como um título e layout, para uma página ou publicação no seu site, você pode adicionar a página inicial YAML na parte superior de qualquer arquivo Markdown ou HTML. Para saber mais, confira Front Matter na documentação do Jekyll.

Se você estiver publicando por meio de um branch, as alterações em seu site serão publicadas automaticamente quando as alterações forem mescladas na fonte de publicação do site. Se você estiver publicando por meio de um fluxo de trabalho personalizado de GitHub Actions, as alterações serão publicadas sempre que seu fluxo de trabalho for disparado (normalmente por um push para o branch padrão). Se desejar visualizar as alterações primeiro, faça as alterações localmente em vez de fazê-las no GitHub. Em seguida, teste seu site localmente. Para saber mais, confira Testar o site do GitHub Pages localmente com o Jekyll.

Adicionar uma nova página ao site

  1. No GitHub, acesse o repositório do seu site.

  2. Navegue até a fonte de publicação do seu site. Para saber mais, confira Configurar uma fonte de publicação para o site do GitHub Pages.

  3. Na raiz da fonte de publicação, crie um arquivo para sua página chamado PAGE-NAME.md, substituindo PAGE-NAME por um nome de arquivo adequado para a página.

  4. Adicione o frontmatter YAML a seguir ao início do arquivo, substituindo PAGE-TITLE pelo título da página e URL-PATH por um caminho desejado para a URL da página. Por exemplo, se a URL base do site for https://octocat.github.io e a URL-PATH for /about/contact/, a página estará localizada em https://octocat.github.io/about/contact.

    layout: page
title: "PAGE-TITLE"
permalink: /URL-PATH

  5. Abaixo da página inicial, adicione conteúdo para a página.

  6. Clique em Fazer commit das alterações...

  7. No campo "Mensagem do commit", digite uma mensagem curta e relevante que descreva a alteração que você fez no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para saber mais, confira Criar um commit com vários autores.

  8. Se você tiver mais de um endereço de email associado à sua conta em GitHub, clique no menu suspenso do endereço de email e selecione o email a ser usado como o endereço de email do autor do Git. Apenas endereços de e-mail verificados aparecem neste menu suspenso. Se você habilitou a privacidade do endereço de email, um email sem resposta será o endereço de email do autor de commit padrão. Para obter mais informações sobre a forma exata que o endereço de email sem resposta pode assumir, confira Configurar o endereço de e-mail do commit.

    Captura de tela de uma solicitação de pull do GitHub que mostra um menu suspenso com opções para escolher o endereço de email do autor do commit. octocat@github.com está selecionado.

  9. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para saber mais, confira Como criar uma solicitação de pull.

    Captura de tela de uma solicitação de pull do GitHub que mostra um botão de opção para fazer commit diretamente na ramificação principal ou para criar um branch. O novo branch está selecionado.

  10. Clique em Fazer commit de alterações ou em Propor alterações.

  11. Crie um pull request para suas alterações propostas.

  12. Na lista de "Pull Requests", clique no pull request que você deseja mesclar.

  13. Clique em Mesclar solicitação de pull. Para saber mais, confira Mesclar uma solicitação de pull.

  14. Se solicitado, digite uma mensagem de commit ou aceite a mensagem padrão.

  15. Clique em Confirmar mesclagem.

  16. Opcionalmente, exclua o branch. Para saber mais, confira Criar e excluir branches no repositório.

Adicionar uma nova postagem ao site

  1. No GitHub, acesse o repositório do seu site.

  2. Navegue até a fonte de publicação do seu site. Para saber mais, confira Configurar uma fonte de publicação para o site do GitHub Pages.

  3. Navegue até o diretório _posts.

  4. Crie um arquivo chamado YYYY-MM-DD-NAME-OF-POST.md, substituindo YYYY-MM-DD pela data da postagem e NAME-OF-POST pelo nome da postagem.

  5. Adicione o frontmatter YAML a seguir à parte inicial do arquivo, incluindo o título da postagem entre aspas, a data e a hora da postagem no formato YYYYY-MM-DD hh:mm:ss -0000 e quantas categorias desejar para sua postagem.

    layout: post
title: "POST-TITLE"
date: YYYY-MM-DD hh:mm:ss -0000
categories: CATEGORY-1 CATEGORY-2

  6. Abaixo da página inicial, adicione conteúdo para a postagem.

  7. Clique em Fazer commit das alterações...

  8. No campo "Mensagem do commit", digite uma mensagem curta e relevante que descreva a alteração que você fez no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para saber mais, confira Criar um commit com vários autores.

  9. Se você tiver mais de um endereço de email associado à sua conta em GitHub, clique no menu suspenso do endereço de email e selecione o email a ser usado como o endereço de email do autor do Git. Apenas endereços de e-mail verificados aparecem neste menu suspenso. Se você habilitou a privacidade do endereço de email, um email sem resposta será o endereço de email do autor de commit padrão. Para obter mais informações sobre a forma exata que o endereço de email sem resposta pode assumir, confira Configurar o endereço de e-mail do commit.

    Captura de tela de uma solicitação de pull do GitHub que mostra um menu suspenso com opções para escolher o endereço de email do autor do commit. octocat@github.com está selecionado.

  10. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para saber mais, confira Como criar uma solicitação de pull.

    Captura de tela de uma solicitação de pull do GitHub que mostra um botão de opção para fazer commit diretamente na ramificação principal ou para criar um branch. O novo branch está selecionado.

  11. Clique em Fazer commit de alterações ou em Propor alterações.

  12. Crie um pull request para suas alterações propostas.

  13. Na lista de "Pull Requests", clique no pull request que você deseja mesclar.

  14. Clique em Mesclar solicitação de pull. Para saber mais, confira Mesclar uma solicitação de pull.

  15. Se solicitado, digite uma mensagem de commit ou aceite a mensagem padrão.

  16. Clique em Confirmar mesclagem.

  17. Opcionalmente, exclua o branch. Para saber mais, confira Criar e excluir branches no repositório.

Seu post já deve estar no seu site! Se a URL base do site for https://octocat.github.io, a nova postagem estará localizada em https://octocat.github.io/YYYY/MM/DD/TITLE.html.

Próximas etapas

É possível adicionar um tema do Jekyll ao site do GitHub Pages para personalizar a aparência do seu site. Para saber, confira Adicionar um tema ao site do GitHub Pages usando Jekyll.