Todos os elementos de Markdown com um exemplo que você pode editar e ver renderizado na hora: quebras de linha, links, tabelas, checkboxes, notas de rodapé, blocos de código e alertas do GitHub, além de um modelo de README.
O Markdown formata texto simples com alguns símbolos: # para títulos, **dois asteriscos** para negrito, [texto](endereço) para links, - para listas com marcadores e três crases para blocos de código. Cada exemplo abaixo pode ser editado, e a prévia ao lado é atualizada enquanto você digita, para você testar uma sintaxe antes de usá-la.
Os cinco que você mais vai usar
Dezoito exemplos ao vivo que cobrem tudo, de títulos a notas de rodapé e alertas do GitHub, uma tabela com as diferenças entre o GitHub e o CommonMark padrão, um modelo de README e um editor completo no fim da página.
Termine a linha com dois espaços ou uma barra invertida e depois pressione Enter. Um Enter simples é tratado como espaço e as linhas se juntam. Para um novo parágrafo em vez de uma quebra de linha, deixe uma linha em branco.
Comece um item de lista com - [ ] para uma caixa vazia ou - [x] para uma marcada. As listas de tarefas fazem parte do GitHub Flavored Markdown, então funcionam no GitHub, no GitLab e na maioria dos apps de notas, mas não no CommonMark estrito.
Escreva a linha de cabeçalho com barras verticais entre as colunas, depois uma linha de hífens e depois uma linha por registro. As colunas não precisam estar alinhadas no código-fonte. Adicione dois-pontos na linha de hífens para alinhar uma coluna à esquerda, à direita ou ao centro.
Markdown é a sintaxe original de 2004, que deixou muitos casos indefinidos. CommonMark é uma especificação precisa dessa sintaxe central. GitHub Flavored Markdown é o CommonMark mais tabelas, listas de tarefas, tachado, links automáticos e notas de rodapé, e é o que a maioria das ferramentas para desenvolvedores segue.
A maioria dos renderizadores permite, então as tags details e summary ou uma imagem centralizada são comuns em READMEs. O GitHub remove scripts, estilos e alguns atributos por segurança. As prévias desta página não renderizam HTML puro, então o mostram como texto.
De um a seis sinais #, seguidos de um espaço. Use um único título # por documento.
Sublinhados (__bold__, _italic_) também funcionam, mas não no meio de uma palavra.
Dois tis de cada lado. Faz parte do GitHub Flavored Markdown, não do CommonMark central.
Um Enter simples não quebra a linha. Termine-a com dois espaços ou uma barra invertida, ou deixe uma linha em branco para um novo parágrafo.
Texto entre colchetes, endereço entre parênteses. Os sinais de menor e maior tornam clicável um endereço solto.
Mantém endereços longos fora do texto. As definições podem ficar em qualquer lugar e não são exibidas.
Como um link, com ! na frente. O texto entre colchetes é o texto alternativo que os leitores de tela leem em voz alta.
Use -, * ou + para marcadores e 1. para números. Recue de dois a quatro espaços para aninhar.
Um espaço entre os colchetes é desmarcado; um x é marcado. No GitHub você pode marcá-las nas issues.
Comece cada linha com >. Uma linha só com > mantém os parágrafos na mesma citação.
As crases mantêm o texto exatamente como foi digitado. Para mostrar uma crase, envolva com duas: `` a`b ``.
Três crases antes e depois. A palavra depois da abertura indica a linguagem para o destaque de sintaxe.
Barras verticais separam as colunas; a linha de hífens é obrigatória. Os dois-pontos definem o alinhamento: esquerda, direita ou centro.
Três ou mais hífens, asteriscos ou sublinhados sozinhos em uma linha. Deixe linhas em branco ao redor dos hífens para que não sejam lidos como sublinhado de um título.
A nota é reunida no fim do documento com um link de volta.
Uma barra invertida antes de * _ # [ ] ` e caracteres parecidos os mostra como texto simples.
O GitHub transforma endereços simples em links. O CommonMark estrito precisa dos sinais de menor e maior.
O GitHub os mostra como caixas coloridas; outros apps mostram uma citação simples, como faz a prévia aqui.
Sintaxe de Markdown e onde ela funciona
Onde o GitHub Flavored Markdown difere do CommonMark
Em todo lugar
GitHub e a maioria dos apps
Só no GitHub
Markdown (edite aqui)
Prévia
Copiar
Redefinir
Sintaxe em resumo
Todos os elementos, ao vivo
GitHub vs CommonMark
Modelo de README
Copiar modelo
Abrir no editor
Editor completo
Markdown
Copiar Markdown
{n} palavras. Nada é salvo nem enviado.
Comece grátis · Sem cartão de crédito