Guia rápido de Markdown para documentos prontos a partilhar
Consulta este guia de Markdown para títulos, ênfase, listas, ligações, tabelas, tarefas e código e compara um exemplo apresentado.
Um guia rápido útil ajuda-te a terminar um documento, sem memorizar todos os dialetos de Markdown. Abre o guia de Markdown enquanto escreves e usa este artigo para confirmar a sintaxe habitual e o seu resultado visual. Abrange elementos comuns de documentos; fórmulas e diagramas precisam das suas próprias referências.
Este exemplo combina títulos, estilos de texto, lista, citação, ligação, tabela e tarefa. Copia-o como um todo para perceberes como os elementos funcionam em conjunto, em vez de testares símbolos isolados.
# Markdown field guide
## Inline text
**Bold**, *emphasis*, and `inline code`.
## Lists
- First item
- Second item
> A short quotation.
[Documentation](https://spec.commonmark.org/current/)
| Item | State |
|:--|:--|
| Draft | Reviewed |
- [x] GFM task list
A imagem exportada mostra a hierarquia visual. Guarda também o Markdown: o texto e os destinos das ligações continuam editáveis na fonte, enquanto PNG é uma cópia visual.
- Secções: usa
#,##e###seguidos de um espaço para títulos de nível descendente. Escolhe o nível pela estrutura do documento, não pelo tamanho pretendido num cartão. - Significado em linha:
**bold**destaca uma expressão-chave,*emphasis*dá uma ênfase mais leve e os acentos graves protegem identificadores curtos de código. Evita parágrafos inteiros a negrito. - Listas: usa
-para marcadores ou números seguidos de ponto e espaço para passos. Indenta os itens secundários por baixo do item principal. As linhas vazias tornam os blocos mais fáceis de inspecionar na fonte. - Citações: começa as linhas citadas com
>. Se citares outra pessoa, identifica a fonte no texto próximo. - Ligações e imagens:
[label](URL)cria uma ligação. Uma imagem usa a mesma estrutura com uma exclamação antes; o texto entre parênteses retos descreve a imagem.
Tabelas, listas de tarefas e texto rasurado são extensões GFM, não funcionalidades garantidas em todos os renderizadores Markdown. A especificação CommonMark e a especificação GFM distinguem regras base de extensões. Verifica essas funções no destino em que vais usar o documento.
O segundo exemplo acrescenta uma lista ordenada com um item aninhado, asteriscos literais, uma linha divisória e um bloco de código com cerca. A cerca exterior de quatro acentos graves permite mostrar literalmente a interior de três.
### A smaller section
1. Review the draft
- Check the facts
2. Export the result
~~Old wording~~ and \*literal asterisks\*.
---
```javascript
console.log("Ready");
```
O identificador da linguagem depois da cerca ajuda a escolher o realce. Não executa o programa nem confirma que o código está correto.
Depois de confirmares a sintaxe, cola o documento no conversor Markdown. Escolhe uma largura em que a linha mais longa e a tabela sejam legíveis. Inspeciona o ficheiro descarregado além da pré-visualização e coloca as ligações importantes no texto que acompanha a imagem: uma imagem não contém ligações Markdown clicáveis.
Mantém o guia interativo à mão. Para problemas concretos, consulta os erros comuns de Markdown; para exemplos longos e cercas, segue o guia de blocos de código.