What is Markdown?

Markdown is a lightweight markup language created by John Gruber in 2004. It allows you to write formatted documents using simple text syntax that is easy to read and write. Markdown is widely used in README files, documentation, blogs, forums and content management systems.

Sintaxe Markdown Básica

# H1
## H2
### H3

**negrito**
*itálico*
~~tachado~~

- Item 1
- Item 2

1. Primeiro
2. Segundo

[texto](url)
![alt](imagem.jpg)

`código inline`

```
bloco de código
```

> Citação
> multilinha

---

Use Cases Comuns

• README.md: Documentação de projetos no GitHub, GitLab, etc.
• Blogs: Muitos sistemas (Jekyll, Hugo, Gatsby) usam Markdown
• Documentação: MkDocs, Docusaurus, GitBook
• Notas: Obsidian, Notion, Bear, Joplin
• Fóruns: Stack Overflow, Reddit, Discord
• Emails: Alguns clientes suportam Markdown
• Comentários: Muitos sistemas de comentários (Discourse, etc.)

Vantagens do Markdown

Sabores de Markdown

Existem várias "versões" de Markdown com extensões adicionais:

• CommonMark: Especificação padronizada de Markdown
• GitHub Flavored Markdown (GFM): Adiciona tabelas, listas de tarefas, menções
• Markdown Extra: Tabelas, notas de rodapé, definições
• MultiMarkdown: Metadados, referências cruzadas, matemática
• Pandoc Markdown: Extensões acadêmicas e científicas

Tool Limitations

Complete Example

# Meu Projeto

## Instalação

```bash
npm install meu-pacote
```

## Uso

Use assim:

- Importe o módulo
- Configure as opções
- Execute!

**Importante:** Leia a documentação.

[Docs](https://exemplo.com)

<h1>Meu Projeto</h1>

<h2>Instalação</h2>

<pre><code>npm install...</code></pre>

<h2>Uso</h2>

<p>Use assim:</p>

<ul>
  <li>Importe o módulo</li>
  <li>Configure...</li>
</ul>

<p><strong>Importante:</strong>...</p>

Best Practices

• Consistência: Escolha um estilo (-, *, __, etc.) e mantenha-o
• Quebras de linha: Use linha em branco para separar paragraphs
• Links: Use URLs complete, não relativas quando possível
• Acessibilidade: Sempre adicione texto alt em imagens
• Heading hierarchy: Use níveis de cabeçalho sequenciais (H1 → H2 → H3)
• Code blocks: Especifique a linguagem para syntax highlighting

Editores Markdown Recomendados

Frequently Asked Questions

Markdown vs HTML: Qual usar?

Use Markdown para conteúdo simples e legível. Use HTML quando precisar de controle total sobre layout e estilo. Muitos sistemas permitem misturar ambos quando necessário.

Como adicionar tabelas em Markdown?

Tabelas não fazem parte do Markdown original, mas são suportadas em GFM (GitHub Flavored Markdown) e outros sabores. Esta ferramenta básica não suporta tabelas, mas bibliotecas como markdown-it suportam.

Posso usar HTML dentro de Markdown?

Sim! A maioria dos parsers Markdown permite HTML inline para casos que Markdown não cobre. É especialmente útil para elementos complexos ou estilização customizada.