Sobre como escrever e formatar em GitHub

GitHub combina uma sintaxe para formatar texto chamada GitHub Flavored Markdown com algumas funcionalidades de escrita exclusivas.

Quem pode usar esse recurso?

O Markdown pode ser usado na interface Web do GitHub.

Neste artigo

O Markdown é uma linguagem fácil de ler e de gravar para formatar texto sem formatação.

Adicionamos algumas funcionalidades personalizadas para criar o markdown em estilo GitHub, usadas para formatar prosa e código em nosso site.

Também é possível interagir com outros usuários em solicitações de pull e problemas usando recursos como @-mentions, referências de problemas e de solicitações de pull e emojis. Para saber mais, confira Sintaxe básica de escrita e formatação.

Barra de ferramentas de formatação de texto

Cada campo de comentário no GitHub contém uma barra de ferramentas de formatação de texto que permite formatar o texto sem aprender a sintaxe do Markdown. Além da formatação do Markdown, como estilos em negrito e itálico, e da criação de cabeçalhos, links e listas, a barra de ferramentas inclui recursos específicos do GitHub, como @-mentions, listas de tarefas e links para problemas e pull requests.

Habilitando fontes de largura fixa no editor

É possível habilitar uma fonte de largura fixa em cada campo de comentário no GitHub. Cada caractere em uma fonte de largura fixa ou de espaçamento uniforme ocupa o mesmo espaço horizontal. Isso pode facilitar a edição de estruturas Markdown avançadas, como tabelas e snippets de código.

Captura de tela de um comentário do GitHub mostrando uma tabela Markdown de exemplo que lista dois comandos Git. Todas as letras na tabela têm a mesma largura visual.

  1. No canto superior direito de qualquer página do GitHub, clique em sua imagem de perfil e, em seguida, clique em Configurações.
  2. Na barra lateral esquerda, clique em Appearance.
  3. Em "Preferência de fonte do editor Markdown", selecione Usar uma fonte de largura fixa (com espaçamento uniforme) ao editar Markdown.
    Captura de tela das configurações de usuário do GitHub para a preferência de Markdown. A caixa de seleção para usar uma fonte de largura fixa no Markdown está marcada e contornada em laranja escuro.

Leitura adicional

  •           [Especificações do GitHub Flavored Markdown](https://github.github.com/gfm/)

  •         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)

  •         [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting)

  •         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)