O que é o Markdown?
Markdown é uma linguagem de marcação que oferece uma abordagem enxuta para edição de conteúdo, protegendo os criadores de conteúdo da sobrecarga de HTML. Embora o HTML seja ótimo para compor conteúdo exatamente como foi planeado, ocupa muito espaço e pode ser difícil utilizá-lo, mesmo em pequenas doses. A invenção de Markdown permitiu obter um excelente equilíbrio entre a tecnologia do HTML relativamente à descrição de conteúdos e a facilidade do texto simples no que respeita à edição.
Nesta unidade, discutiremos a estrutura e a sintaxe do Markdown. Também abordaremos os recursos do GitHub-Flavored Markdown (GFM), que são extensões de sintaxe que permitem integrar recursos do GitHub ao conteúdo.
Nota
Esta unidade destina-se a dar-lhe uma ideia do que é o Markdown. Para uma revisão mais aprofundada, consulte os artigos "Markdown syntax description" e "GitHub-Flavored Markdown Spec" na unidade Summary no final deste módulo.
Enfatizar texto
A parte mais importante de qualquer comunicação no GitHub geralmente é o texto em si, mas como você mostra que algumas partes do texto são mais importantes do que outras?
Usar itálico no texto é tão fácil quanto cercar o texto de destino com asteriscos únicos () ou sublinhados únicos (*_). Apenas certifique-se de fechar uma ênfase com o mesmo personagem com o qual você a abriu. Esteja atento à forma como combina o uso de asteriscos e sublinhados. Seguem-se vários exemplos:
This is *italic* text.
This is also _italic_ text.
Isto é texto em itálico. Este texto também está em itálico .
Crie texto em negrito usando dois asteriscos () ou dois sublinhados (**__).
This is **bold** text.
This is also __bold__ text.
Isto é texto a negrito. Este também é um texto em negrito .
Também pode misturar diferentes ênfases.
_This is **italic and bold** text_ using a single underscore for italic and double asterisks for bold.
__This is bold and *italic* text__ using double underscores for bold and single asterisks for italic.
Este texto está em itálico e negrito usando um único sublinhado para itálico e asteriscos duplos para negrito. Este é o texto em negrito e itálico usando sublinhados duplos para negrito e asteriscos simples para itálico.
Para usar um asterisco literal, preceda-o com um caractere de fuga; no GFM, isso é uma barra invertida (\). Este exemplo resulta em sublinhados e asteriscos sendo mostrados na saída.
\_This is all \*\*plain\*\* text\_.
_This é tudo **simples** text_.
Declarar títulos
O HTML fornece cabeçalhos de conteúdos, como a tag <h1>. Em Markdown, isto é suportado através do símbolo #. Basta utilizar um # para cada nível de cabeçalho de 1 a 6.
###### This is H6 text
This is H6 text
Link para imagens e sites
Os links de imagem e site usam uma sintaxe semelhante.
[Link to Microsoft Training](/training)
Fazer listas
Pode definir listas ordenadas ou não ordenadas. Também pode definir itens aninhados através de avanço.
- As listas ordenadas começam com números.
- Listas não ordenadas podem usar asteriscos ou traços (
-).
Aqui está o Markdown para uma lista ordenada:
1. First
1. Second
1. Third
Resultado:
- First
- Second
- Terceiro
- First
- Nested
- Second
- Third
Aqui está o Markdown para uma lista não ordenada:
- Primeiros
- Aninhado
- Second
- Terceiro
Criar tabelas
Você pode construir tabelas usando uma combinação de pipes () para quebras de coluna e traços (|-) para designar a linha anterior como um cabeçalho.
First|Second
-|-
1|2
3|4
First Second 1 2 3 4
Texto da citação
Você pode criar blockquotes usando o caractere maior que (>).
> This is quoted text.
Isto é um texto citado.
Preencha as lacunas com HTML embutido
Se você se deparar com um cenário HTML não suportado pelo Markdown, poderá usar esse HTML embutido.
Here is a<br />line break
Eis uma
quebra de linha
Trabalhar com código
Markdown fornece comportamento padrão para trabalhar com blocos de código embutidos delimitados pelo caractere backtick ('). Ao decorar o texto com esse caractere, ele é renderizado como código.
This is `code`.
Isto é
code(código).
Se você tiver um segmento de código abrangendo várias linhas, poderá usar três backticks (''') antes e depois para criar um bloco de código cercado.
```markdown
var first = 1;
var second = 2;
var sum = first + second;
```
var first = 1; var second = 2; var sum = first + second;
O GFM estende este suporte com destaque da sintaxe para as linguagens populares. Basta especificar a linguagem como parte da primeira sequência do acento.
```javascript
var first = 1;
var second = 2;
var sum = first + second;
```
var first = 1; var second = 2; var sum = first + second;
Problemas de links cruzados e solicitações pull
O GFM suporta vários formatos de shortcode para facilitar a ligação a problemas e pedidos pull. A forma mais fácil de o fazer é ao utilizar o formato #ID, tal como #3602. O GitHub ajusta automaticamente links mais longos para esse formato se você colá-los. Há também convenções adicionais que você pode seguir, como se estiver trabalhando com outras ferramentas ou quiser especificar outros projetos/ramificações.
| Tipo de referência | Referência não processada | Ligação abreviada |
|---|---|---|
| URL de questão ou de pedido Pull | https://github.com/desktop/desktop/pull/3602 |
#3602 |
# e número de questão ou de pedido Pull |
#3602 | #3602 |
GH- e número de questão ou de pedido Pull |
GH-3602 | GH-3602 |
Username/Repository# e número de questão ou de pedido Pull |
desktop/desktop#3602 | desktop/desktop#3602 |
Para obter mais informações, consulte o artigo "Referências e URLs vinculadas automaticamente" na unidade Resumo no final deste módulo.
Compromissos específicos do link
Você pode vincular a uma confirmação colando em seu ID ou simplesmente usando seu algoritmo de hash seguro (SHA).
| Tipo de referência | Referência não processada | Ligação abreviada |
|---|---|---|
| URL de consolidação | https://github.com/desktop/desktop/commit/ | |
| 8304e9c271a5e5ab4fda797304cd7bcca7158c87 | 8304e9c | |
| SHA | 8304e9c271a5e5ab4fda797304cd7bcca7158c87 | 8304e9c |
| User@SHA | desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87 | desktop@8304e9c |
| Nome de utilizador/Repository@SHA | área de trabalho/desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87 | área de trabalho/desktop@8304e9c |
Mencione usuários e equipes
Digitar um símbolo seguido de um @ nome de usuário do GitHub envia uma notificação para essa pessoa sobre o comentário. Isso é chamado de "@mention", porque você está mencionando o indivíduo. Também pode fazer @mention a equipas dentro de uma organização.
@githubteacher
Controlar listas de tarefas
Você pode criar listas de tarefas dentro de problemas ou receber solicitações usando a sintaxe a seguir. Podem ser úteis para acompanhar o progresso quando utilizadas no corpo de uma questão ou pedido Pull.
- [x] First task
- [x] Second task
- [ ] Third task
Comandos de barra
Os comandos de barra podem economizar seu tempo, reduzindo a digitação necessária para criar Markdown complexo.
Você pode usar comandos de barra em qualquer campo de descrição ou comentário em problemas, solicitações pull ou discussões em que esse comando de barra é suportado.
| Comando | Description |
|---|---|
/code |
Insere um bloco de código Markdown. Você escolhe o idioma. |
/details |
Insere uma área de detalhes dobrável. Você escolhe o título e o conteúdo. |
/saved-replies |
Insere uma resposta salva. Você escolhe entre as respostas salvas para sua conta de usuário. Se você adicionar %cursor% à resposta salva, o comando barra colocará o cursor nesse local. |
/table |
Insere uma tabela Markdown. Você escolhe o número de colunas e linhas. |
/tasklist |
Insere uma lista de tarefas. Este comando de barra só funciona em uma descrição de problema. |
/template |
Mostra todos os modelos no repositório. Você escolhe o modelo a ser inserido. Este comando de barra funciona para modelos de problema e um modelo de solicitação pull. |