Documentação Profissional com Markdown

Seu código pode ser ótimo, mas sem documentação ninguém vai usar. Aprenda a criar READMEs e Pull Requests elegantes.

Logo do Git e GitHub

Onde usamos Markdown?

Markdown é a linguagem padrão do GitHub. Você vai usá-la principalmente para:

  • 📝 README.md: A capa do seu projeto (apresentação, como instalar, tecnologias).
  • 💬 Pull Requests e Issues: Para descrever o que você fez, criar listas de tarefas e mostrar prints.

Dica: No VS Code, use o botão de "Preview" (no canto superior direito) para ver como seu Markdown está ficando.

1. Títulos e Subtítulos

# Nome do Projeto (H1)
## Funcionalidades (H2)
### Como Instalar (H3)

Como aparece:

Nome do Projeto (H1)

Funcionalidades (H2)

Como Instalar (H3)

2. Estilizando Texto

**Texto em Negrito** para destaque.
*Texto em Itálico* para observações.
~~Texto Riscado~~ para tarefas canceladas.

Como aparece:

Texto em Negrito para destaque.
Texto em Itálico para observações.
Texto Riscado para tarefas canceladas.

3. Mostrando Código (Essencial)

Para criar aquelas "caixinhas pretas" de código coloridas, você precisa:

  1. Abrir com três crases (```) e o nome da linguagem (ex: bash, js).
  2. Colocar o seu código.
  3. IMPORTANTE: Fechar com mais três crases (```) na linha de baixo, senão o código "vaza" para o resto do texto!
```bash
git checkout -b corrigir-cor-bola
```

Como aparece:

git checkout -b corrigir-cor-bola

4. Listas

Listas Não Ordenadas (use - ou *):

- Item 1
- Item 2
  - Subitem 2.1
  - Subitem 2.2
- Item 3

Como aparece:

  • Item 1
  • Item 2
    • Subitem 2.1
    • Subitem 2.2
  • Item 3

Listas Ordenadas (use números):

1. Primeiro passo
2. Segundo passo
3. Terceiro passo

Como aparece:

  1. Primeiro passo
  2. Segundo passo
  3. Terceiro passo

Listas de Tarefas (Checkboxes - Muito usado em Pull Requests!):

- [ ] Tarefa pendente
- [x] Tarefa concluída
- [ ] Outra tarefa a fazer

Como aparece:

  • ☐ Tarefa pendente
  • ☑ Tarefa concluída
  • ☐ Outra tarefa a fazer

Links:

[Texto do Link](https://github.com)
[Documentação do Git](https://git-scm.com/doc)

Como aparece:

Texto do Link
Documentação do Git

Imagens:

![Texto alternativo](caminho/da/imagem.png)
![Logo do Projeto](https://exemplo.com/logo.png)

Dica: A diferença entre link e imagem é só a exclamação ! no início!

6. Tabelas

Muito útil para listar tecnologias ou comparações:

| Tecnologia | Versão | Descrição |
|-----------|--------|-----------|
| Node.js   | 18.x   | Backend   |
| React     | 18.2   | Frontend  |
| MongoDB   | 6.0    | Banco de Dados |

Como aparece:

Tecnologia Versão Descrição
Node.js 18.x Backend
React 18.2 Frontend
MongoDB 6.0 Banco de Dados

7. Citações

Para destacar observações importantes:

> Esta é uma citação importante.
> Pode ter várias linhas.

Como aparece:

Esta é uma citação importante.
Pode ter várias linhas.

Exemplo de README Profissional

Agora que você conhece todos os recursos, veja como criar um README completo:

# 🎮 Nome do Projeto

Breve descrição do que o projeto faz.

## 📋 Funcionalidades

- [x] Login de usuários
- [x] Dashboard interativo
- [ ] Sistema de notificações (em desenvolvimento)

## 🚀 Como Instalar

```bash
git clone https://github.com/usuario/projeto.git
cd projeto
npm install
npm start
```

## 🛠️ Tecnologias

| Tecnologia | Descrição |
|-----------|-----------|
| React     | Interface |
| Node.js   | Backend   |

## 📝 Licença

Este projeto está sob a licença MIT.

💡 Dica Final

Sempre use o Preview do VS Code (Ctrl+Shift+V) para ver como seu Markdown está ficando antes de fazer commit!

Próximos Passos...

Na próxima etapa, você vai aprender sobre o GitHub Pages. Descubra como hospedar o seu site de forma totalmente gratuita e profissional diretamente pelo GitHub.