Skip to main content

Enterprise Server 3.20 está disponível no momento como versão candidata a lançamento.

Adicionando conteúdo ao seu site 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.

Observação

Embora o gem github-pages continue tendo suporte para alguns fluxos de trabalho, GitHub Actions agora é a abordagem recomendada para implantar e automatizar sites do GitHub Pages.

Pessoas com permissão de escrita para um repositório podem adicionar conteúdo a um site GitHub Pages usando 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 Criando um site de páginas GitHub com Jekyll.

Os principais tipos de conteúdo para sites do Jekyll são páginas e postagens. Uma página destina-se a conteúdo autônomo que não está associado a uma data específica, como uma página "Sobre nós". 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.

Uma postagem é um post 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 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 GitHub Pages e 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.

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 Configurando uma fonte de publicação para seu site 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 seu site for https://octocat.github.io e o caminho da URL 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 do frontmatter, adicione conteúdo para a sua 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. 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.

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

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

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

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

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

  14. Clique em Confirmar mesclagem.

  15. 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 Configurando uma fonte de publicação para seu site GitHub Pages.

  3. Navegue até o _posts diretório.

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

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 mais informações, consulte Adicionando um tema ao site GitHub Pages usando o Jekyll.