Como formatar código em markdown

Artigo original: How to Format Code in Markdown

Existem duas maneiras de formatar código em markdown. Você pode inserir o código em uma linha, envolvendo o texto com acento grave (`), ou pode usar um bloco de código isolado, onde alguns formatadores de texto vão realçar a sintaxe com cores.

Código em linha

Você pode usar a formatação de código em linha para enfatizar um pequeno comando ou uma parte da sintaxe dentro da linha que esteja escrevendo.

Por exemplo, você pode desejar mencionar o método Array.protoype.map() do Java. Ao usar a formatação de código em linha, fica claro que essa é uma parte do código. Você também pode usá-la para ilustrar um comando do terminal, como yarn install.

Para usar formatação de código em linha, somente envolva com acentos graves (`) o código que deseja formatar. No padrão de teclado dos Estados Unidos (US QWERTY), essa tecla pode ser encontrada à esquerda do número 1, acima da tecla TAB. No padrão de teclado português do Brasil (ABNT2), essa tecla se encontra ao lado direito da letra P, na mesma tecla que possui o acento agudo, sendo necessário utilizar a tecla SHIFT em conjunto. No padrão de teclado do português de Portugal, essa tecla se encontra entre a tecla "Enter" e a tecla de asterisco, também sendo necessário utilizar a tecla SHIFT em conjunto. Mais informações sobre a localização da tecla de acento grave em teclados internacionais são fornecidas abaixo.

Por exemplo, escrever `Array.prototype.map()` em markdown vai ser renderizado como Array.prototype.map().

Blocos de código

Para escrever partes do código mais longas ou detalhadas, é frequentemente melhor colocá-los em um bloco de código. Blocos de código permitem múltiplas linhas e serão renderizados pelo markdown em blocos isolados usando fonte de código.

Para fazer isso, comece seu bloco em uma linha com três acentos graves. Isso sinaliza ao markdown que você está criando um bloco de código. Você precisará encerrar o bloco com outra linha contendo três acentos graves. Por exemplo:

```
var adicionar2 = function(numero) {
 return numero + 2;
}
```

vai renderizar em markdown como:

var adicionar2 = function(numero) {
  return numero + 2;
}

Realce de sintaxe

Ainda que não suportado nativamente pelo markdown, muitos mecanismos de markdown, incluindo os usados pelo GitHub, suportam realce de sintaxe. Isso significa que, ao informar qual linguagem de programação está no bloco de código, o mecanismo vai adicionar cores assim como uma IDE faria.

Você pode fazer isso ao adicionar o nome da linguagem na mesma linha em que inicia o bloco de código, junto aos três acentos graves. No exemplo acima, ao invés da primeira linha ser ```, você escreveria ```js, e o realce de sintaxe de JavaScript seria aplicado ao bloco.

var adicionar2 = function(numero) {
  return numero + 2;
}

O realce de sintaxe está disponível em outras linguagens além de JavaScript. Você pode usar ```html:

<div class="row">
  <div class="col-md-6 col-md-offset-3">
    <h1>Olá Mundo</h1>
  </div>
</div>

```ruby:

"Ola Mundo".split('').each do |letter|
  puts letter
end

ou ```python:

a, b = 0, 1
while b < 10:
    print(b)
    a, b = a, a + b

Lembre-se apenas de que nem todos os mecanismos de markdown vão aplicar realce de sintaxe.

Acento grave em teclados internacionais

A localização do acento grave pode variar em diferentes teclados. Se você não está usando o padrão QWERTY, pode ser difícil encontrar. Segue abaixo um exemplo de como encontrá-lo em um teclado AZERTY:

AZERTY: