O Guia Definitivo de Markdown: Sintaxe, Visualização e Melhores Práticas

Markdown é uma linguagem de marcação leve com sintaxe de formatação de texto simples. É amplamente utilizada para arquivos README, documentação e postagens de blog. Por ser fácil de ler e escrever, o Markdown tornou-se o padrão para a comunicação entre desenvolvedores.

Use esta folha de dicas como uma referência rápida para a sintaxe padrão do Markdown e do GitHub Flavored Markdown (GFM).

---

1. Formatação de Texto

Estilo básico para o seu texto.

Elemento	Sintaxe	Resultado
Cabeçalhos	# H1 a ###### H6	H1 a H6
Negrito	**texto** ou __texto__	texto
Itálico	*texto* ou _texto_	texto
Tachado	~~texto~~	texto
Citação	> citação	> citação
Régua Horizontal	--- ou ***

---

2. Listas

Organize seu conteúdo com listas ordenadas, não ordenadas ou de tarefas.

• Lista Não Ordenada: Use *, - ou +.

  - Item 1
  - Item 2
    - Subitem
  

• Lista Ordenada: Use números seguidos de um ponto.

  1. Primeiro item
  2. Segundo item
  

• Lista de Tarefas (GFM):

  - [x] Tarefa concluída
  - [ ] Tarefa incompleta
  

---

3. Links e Imagens

• Link: [Texto](URL) -> Google
• Imagem: ![Texto alternativo](URL)
• Link com Título: [Texto](URL "Título")

---

4. Blocos de Código

• Código em linha: Use crases simples: `código`.
• Bloco de Código: Use crases triplas com destaque de linguagem opcional:

  ```javascript
  console.log("Olá, Mundo!");
  

---

5. Tabelas e Sintaxe Avançada

Tabelas:

| Cabeçalho 1 | Cabeçalho 2 |
| :--- | :--- |
| Célula 1 | Célula 2 |
| Célula 3 | Célula 4 |

Notas de rodapé:

Aqui está uma referência de nota de rodapé[^1].
[^1]: Este é o conteúdo da nota de rodapé.

---

6. Sabores de Markdown (Flavors)

• CommonMark: A versão padrão e altamente compatível do Markdown.
• GitHub Flavored Markdown (GFM): Adiciona suporte para tabelas, listas de tarefas, tachado e links automáticos. A maioria dos renderizadores modernos suporta GFM.
• HTML no Markdown: Você pode usar tags HTML puras (como <u> ou <div>) dentro do Markdown para layouts mais complexos, embora alguns renderizadores possam removê-las por segurança.

---

Perguntas Comuns (FAQ)

P: Como posso visualizar meu Markdown?

R: A maioria dos editores de código, como o VS Code, possui uma Visualização de Markdown integrada (Ctrl+Shift+V). Você também pode usar renderizadores de Markdown online ou editores especializados para ver como seu documento ficará após ser convertido para HTML.

P: Qual é a diferença entre um editor de Markdown e um renderizador?

R: Um editor é onde você escreve a sintaxe de texto simples. Um renderizador (ou parser) é o mecanismo que converte essa sintaxis em HTML para exibição em um navegador.

P: Quais são as melhores práticas para escrever Markdown?

R:

1. Consistência: Use apenas um estilo para listas (- vs *) e cabeçalhos.
2. Legibilidade: Use linhas em branco entre parágrafos e itens de lista.
3. Texto Alternativo: Sempre forneça um texto alternativo significativo para as imagens para garantir a acessibilidade.
4. Delimitação de Código: Sempre especifique a linguagem para blocos de código para habilitar o destaque de sintaxe.

---

Relacionado no Tool3M

• Markdown para HTML: Converta e visualize instantaneamente seu Markdown em HTML limpo e pronto para produção.
• Formatador SQL: Formate blocos de código SQL para colar em sua documentação Markdown.