Skip to main content

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.

GitHub Pages está disponível em repositórios públicos com GitHub Free e GitHub Free para organizações, e em repositórios públicos e privados com GitHub Pro, GitHub Team, GitHub Enterprise Cloud e GitHub Enterprise Server. Para obter mais informações, confira "produtos de GitHub".

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 Markdown: o kramdown e o próprio processador Markdown do GitHub, que é usado para renderizar o GFM (GitHub Flavored Markdown) no GitHub. Para obter mais informações, confira "Sobre a gravação e a formatação no GitHub".

Você pode usar o Markdown enriquecido de GitHub com qualquer um dos processadores, mas apenas o nosso processador de GFM sempre corresponderá aos resultados que você vê em GitHub.

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

    Botão Editar arquivo

    Nota: Em vez de editar e confirmar o arquivo usando o editor de arquivos padrão, você pode optar por usar o editor de código github.dev clicando no menu suspenso ao lado de e selecionando Abrir no github.dev.

    Menu suspenso do botão Editar arquivo

  4. Localize a linha que começa com markdown: e altere o valor para kramdown ou GFM. Configuração Markdown em config.yml 1. No final da página, digite uma mensagem de commit curta e significativa que descreva a alteração feita no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, confira "Como criar um commit com vários coautores". Mensagem de commit para a alteração

  5. Se você tiver mais de um endereço de email associado à sua conta do GitHub.com, clique no menu suspenso do endereço de email e selecione o endereço de 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, <username>@users.noreply.github.com é o endereço de email do autor de commit padrão. Para obter mais informações, confira "Como definir seu endereço de email de commit". Escolher endereços de email de commit 1. 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 obter mais informações, confira "Como criar uma solicitação de pull". Opções de commit no branch 1. Clique em Propor novo arquivo. Botão Propor novo arquivo

Leitura adicional