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

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.

   

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

   

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

Leitura adicional

• Documentação do kramdown
• Especificações do GitHub Flavored Markdown