Voltar para Wiki
Programação3 Módulos

Dominando o Markdown

Aprenda a linguagem de marcação mais usada por desenvolvedores. Escreva documentação, READMEs e artigos de forma simples e rápida.

1

Introdução e Formatação

O que é Markdown?

Markdown é uma linguagem de marcação leve. Diferente do Word, onde você clica em botões para formatar, no Markdown você usa caracteres especiais para dizer ao texto como ele deve se comportar.
Basicamente, é escrever texto simples que é convertido para HTML. É o padrão da indústria para documentação técnica (GitHub, GitLab, StackOverflow, etc).

Estilizando Texto

Para dar ênfase ao texto, usamos asteriscos ou tils. A sintaxe é muito intuitiva:
markdown
**Negrito**: Use dois asteriscos envolvendo a palavra.
*Itálico*: Use um asterisco.
~~Tachado~~: Use dois tils (tildes).

Como fica na tela:

  • Texto em Negrito
  • *Texto em Itálico*
  • ~~Texto Riscado/Tachado~~
2

Estrutura do Documento

Títulos e Cabeçalhos

A hierarquia é definida pela quantidade de hashtags (`#`). Quanto menos hashtags, maior a fonte e a importância.
markdown
# Título H1 (Principal - Use apenas um por arquivo)
## Título H2 (Seção)
### Título H3 (Sub-seção)
#### Título H4...
Dica: Mantenha a ordem lógica (H1 -> H2 -> H3) para garantir acessibilidade e bom SEO.

Listas e Organização

Você pode criar listas ordenadas (números) ou não ordenadas (bullets) facilmente.
markdown
- Item de lista com hífen
* Ou com asterisco
  - Subitem (basta dar espaço/tab)

1. Primeiro passo
2. Segundo passo

Task Lists (Checklists)

Muito comum em Pull Requests no GitHub para marcar tarefas:
markdown
- [x] Tarefa concluída (com x)
- [ ] Tarefa pendente (com espaço)
3

Recursos para Desenvolvedores

Inserindo Códigos

Existem duas formas: Inline (no meio da frase) e em Bloco (multilinha).

Código Inline

Use uma crase simples (` `) para destacar comandos, nomes de arquivos ou variáveis.
markdown
Para instalar, rode o comando `npm install` no terminal.

Bloco de Código (Code Fencing)

Use três crases (```) para criar um bloco. Se você especificar a linguagem logo após as crases, o Markdown aplica coloração de sintaxe.
markdown
```javascript
const hello = "Mundo";
console.log(hello);
```

Links, Imagens e Citações

A sintaxe de imagem é igual a de link, mas com um ponto de exclamação na frente.
markdown
[Texto do Link](https://google.com)

![Texto Alternativo da Imagem](/caminho/da/foto.png)

Blockquotes (Citações)

Use o sinal de maior `>` para criar blocos de destaque ou citações.
markdown
> Importante: Sempre faça backup antes de rodar comandos destrutivos.

Referências & Links Úteis

Markdown Guide (Oficial)↗StackEdit (Editor Online)↗CommonMark Spec↗