Definir um processador markdown para seu site do GitHub Pages usando o Jekyll

Você pode escolher um processador markdown para determinar como o markdown é renderizado no site do 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.

Pessoas com permissões de gravação para um repositório podem definir um processador markdown para um site do GitHub Pages.

O GitHub Pages dá suporte a dois processadores de Markdown: o kramdown e o próprio processador de Markdown do GitHub, que é usado para renderizar o GFM (GitHub Flavored Markdown) no GitHub. Para saber mais, confira Sobre gravação e formatação no GitHub.

Você pode usar o GitHub Flavored Markdown com qualquer processador.

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

  2. No repositório, procure o arquivo _config.yml.

  3. No canto superior direito da exibição de arquivo, clique em para abrir o editor de arquivos.

    Captura de tela de um arquivo. No cabeçalho, um botão, rotulado com um ícone de lápis, está contornado em laranja escuro.

    Observação

    Em vez de editar o arquivo e fazer commit dele usando o editor de arquivos padrão, você pode optar por usar o editor de código github.dev selecionando o menu suspenso e clicando em github.dev. Você também pode clonar o repositório e editar o arquivo localmente por meio de GitHub Desktop clicando em GitHub Desktop .

    Captura de tela de um arquivo. No cabeçalho, um ícone de triângulo para baixo está contornado em laranja escuro.

  4. Localize a linha que começa com markdown: e altere o valor para kramdown ou GFM. A linha completa deve ser markdown: kramdown ou markdown: GFM.

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

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

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

  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.

Leitura adicional