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. Markdown oferece um compromisso eficaz entre o poder do HTML para descrição de conteúdo e a facilidade de texto simples para edição.
Nesta unidade, discutiremos a estrutura e a sintaxe do Markdown. Também abordaremos recursos do GitHub-Flavored Markdown (GFM), incluindo extensões para integrar recursos do GitHub ao seu 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 descrição da sintaxe Markdown e GitHub-Flavored Markdown Spec na unidade Resumo 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 caractere que você usou para abri-la. Preste atenção à consistência ao combinar 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 (\). Isso exibe os sublinhados e asteriscos como texto simples.
\_This is all \*\*plain\*\* text\_.
_Isto é tudo **texto** simples_.
Declarar cabeçalhos
HTML fornece títulos de conteúdo, como a <h1> tag . Em Markdown, isto é suportado através do símbolo #. Basta usar uma vez o # para cada nível de título (de 1 a 6).
###### This is H6 text
Este é o texto H6
Link para imagens e sites
Os links de imagens e sites seguem uma estrutura semelhante.
[Link to Microsoft Training](/training)
Fazer listas
Pode definir listas ordenadas ou não ordenadas. Você também pode criar itens aninhados por meio de recuo.
- 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:
- Primeiro
- Segundo
- Terceiro
Aqui está o Markdown para uma lista não ordenada:
- First
- Nested
- Second
- Third
- Primeiro
- Aninhado
- Segundo
- Terceiro
Criar tabelas
Você pode construir tabelas usando uma combinação de pipes (|) como separadores de colunas e traços (-) para designar a linha anterior como cabeçalho.
First|Second
-|-
1|2
3|4
Primeiro Segundo 1 2 3 4
Texto da citação
Pode criar citações em bloco usando o caractere maior que (>).
> This is quoted text.
Isto é um texto citado.
Preencha as lacunas com HTML embutido
Se te deparares com um cenário HTML não suportado pelo Markdown, podes usar esse HTML em linha.
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 ('). A quebra automática de texto em backticks o renderiza como código.
This is `code`.
Isso é
code.
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 o idioma como parte da primeira sequência de seleção.
```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 códigos curtos para facilitar a ligação a incidentes e pedidos de 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 este formato se os colares. 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 bruta | 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 vinculadas automaticamente e URLs na unidade Resumo 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 bruta | 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 | desktop/desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87 | desktop/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" e destaca o usuário ou a equipe.
@githubteacher
Controlar listas de tarefas
Você pode criar listas de tarefas dentro de issues ou pull requests usando a sintaxe a seguir. Podem ser úteis para acompanhar o progresso quando utilizadas no corpo de um tópico ou pedido de pull.
- [x] First task
- [x] Second task
- [ ] Third task
Comandos de barra
Os comandos de barra podem economizar tempo, reduzindo a digitação necessária para criar conteúdo estruturado.
Você pode usar comandos de barra em qualquer campo de descrição ou comentário em problemas, solicitações pull ou discussões, onde houver suporte.
| Comando | Descrição |
|---|---|
/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 adicionares %cursor% à resposta guardada, o comando de barra posicionará 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 numa descrição de tarefa. |
/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. |