Guia Fácil para Iniciantes: Dicas e Atalhos para Usar Markdown

Se você está começando no GitHub (assim como eu) e quer aprender a usar o Markdown (MD) para formatar seus arquivos README.md, Issues e Pull Requests de forma fácil e eficaz, este artigo é para você!

O que é Markdown?

Markdown é uma linguagem de marcação leve com uma sintaxe fácil de aprender. Ele permite adicionar formatação, como títulos, listas, links e ênfase, usando caracteres simples e intuitivos.

Dicas para Usar Markdown no GitHub:

Cabeçalhos e Títulos:

Use # para criar títulos e cabeçalhos. Quanto mais #, menor o tamanho do título.

Por exemplo:

Estilos de Texto:

• Negrito: Use '**texto**' ou '__texto__'
• Itálico: Use '*texto*' ou '_texto_'
• Riscado: Use '~~texto~~'

Listas:

• Lista Não Ordenada: Use '-' ou '*' antes de cada item.

• Lista Ordenada: Use números seguidos de '.'

Links e Imagens:

• Link: '[Texto do link](URL)'
• Imagem: '

Obs: para pegar a url da imagem, basta copiar e colar ela no GitHub.

Blocos de Código:

Use ` código ` para destacar pequenos trechos de código e tríplie crase (```) para código multilinha.

Citações:

Use ' > ' para criar citações.

Tabelas:

Você pode criar tabelas usando ' | ' para separar colunas e hífens para separar cabeçalhos.

Atalhos Úteis:

• Preview Instantâneo: No GitHub, ao editar um arquivo Markdown, pressione 'Ctrl + Shift + p' para visualizar uma prévia instantânea da renderização Markdown.

• Usar Editores com Suporte a Markdown: Editores como VS Code, Atom, ou mesmo o próprio editor online do GitHub oferecem suporte a Markdown, com recursos de realce de sintaxe que facilitam a escrita.

• Consulte Referências: Mantenha à mão a documentação oficial do GitHub sobre Markdown para consultar outros recursos e detalhes.

Espero que com estas dicas você esteja pronto para criar READMEs e documentos formatados em pouco tempo.

Boa sorte! 🚀