O que é o Markdown?

Concluído

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 do HTML. Embora seja ótimo para renderizar o conteúdo exatamente como ele foi idealizado, o HTML ocupa muito espaço e pode ser difícil de trabalhar, mesmo em pequenas doses. O Markdown oferece um comprometimento efetivo entre o poder do HTML para a descrição do conteúdo e a facilidade de texto sem formatação para edição.

Nesta unidade, vamos discutir a estrutura e a sintaxe do Markdown. Também abordaremos recursos de GitHub-Flavored Markdown (GFM), incluindo extensões para integrar recursos do GitHub ao seu conteúdo.

Observação

A finalidade desta unidade é dar uma ideia do que é o Markdown. Para uma revisão mais detalhada, consulte os artigos Descrição da sintaxe Markdown e Especificação de Markdown variante do GitHub na unidade Resumo desse 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?

Para usar itálico no texto, basta colocar o texto de destino entre asteriscos (*) ou sublinhados (_). Apenas certifique-se de fechar uma ênfase com o mesmo caractere que você usou para abri-lo. Preste atenção à consistência ao combinar asteriscos e sublinhados. Veja os seguintes exemplos:

This is *italic* text.
This is also _italic_ text.

Este é um texto itálico . Esse também é um texto itálico .

Crie texto em negrito usando dois asteriscos (**) ou dois sublinhados (__).

This is **bold** text.
This is also __bold__ text.

Este é um texto em negrito . Esse também é um texto em negrito .

Você também pode misturar tipos de ênfase diferentes.

_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 é um texto itálico e em negrito usando um único sublinhado para itálico e duplos asteriscos para negrito. Este é um texto em negrito e itálico usando sublinhados duplos para negrito e asteriscos únicos para itálico.

Para usar um asterisco literal, preceda-o com um caractere de escape, que no GFM é uma barra invertida (\). Isso exibe os sublinhados e asteriscos como texto sem formatação.

\_This is all \*\*plain\*\* text\_.

_Tudo isto é um texto *sem formatação**_.

Declarar títulos

O HTML fornece cabeçalhos de conteúdo como a marca <h1>. Em Markdown, isso tem suporte por meio do símbolo #. Use apenas um # para cada nível de cabeçalho de 1 a 6.

###### This is H6 text
Este é o texto H6

Os links de imagem e site seguem uma estrutura semelhante.

![Link an image.](/learn/azure-devops/shared/media/mara.png)

Vincule uma imagem.

[Link to Microsoft Training](/training)

Link para o Treinamento da Microsoft

Criar listas

Você pode definir listas ordenadas ou não ordenadas. Você também pode criar itens aninhados por meio do recuo.

  • As listas ordenadas começam com números.
  • As listas não ordenadas podem usar asteriscos ou traços (-).

Aqui está o Markdown de uma lista ordenada:

1. First
1. Second
1. Third

Resultado:

  1. Primeiro
  2. Segundo
  3. Terceiro

Aqui está o Markdown de uma lista não ordenada:

- First
  - Nested
- Second
- Third
  • Primeiro
    • Aninhado
  • Segundo
  • Terceiro

Criar tabelas

Você pode construir tabelas usando uma combinação de barras verticais (|) para quebras de coluna e traços (-) para designar a linha anterior como um cabeçalho.

First|Second
-|-
1|2
3|4
Primeiro Segundo
1 2
3 4

Texto da citação

Você pode criar blockquotes usando o caractere maior que (>).

> This is quoted text.

Este é um texto de referência.

Preencher as lacunas com HTML incorporado

Se você se deparar com uma situação de HTML que não é compatível com o Markdown, você pode usar o HTML incorporado.

Here is a<br />line break

Esta é uma
quebra de linha

Trabalhar com código

O Markdown fornece um comportamento padrão para trabalhar com blocos de código embutidos delimitados pelo caractere de crase (`). Encapsular texto em backticks o renderiza como código.

This is `code`.

Este é um code.

Se tiver um segmento de código que abrange várias linhas, você poderá usar três crases (```) antes e depois para criar um bloco de código isolado.

```markdown
var first = 1;
var second = 2;
var sum = first + second;
```
var first = 1;
var second = 2;
var sum = first + second;

O GFM estende esse suporte com realce de sintaxe para linguagens populares. Basta especificar a linguagem como parte da primeira sequência de crases.

```javascript
var first = 1;
var second = 2;
var sum = first + second;
```
var first = 1;
var second = 2;
var sum = first + second;

O GFM é compatível com o uso de uma variedade de formatos de código curto para facilitar a criação de links para problemas e solicitações de pull. A maneira mais fácil de fazer isso é usar o formato #ID, como #3602. O GitHub ajustará automaticamente os links mais longos para esse formato se você quiser colá-los. Você também poderá seguir convenções adicionais, por exemplo, se estiver trabalhando com outras ferramentas ou se quiser especificar outros projetos/branches.

Tipo de referência Referência bruta Link curto
URL do problema ou da solicitação de pull https://github.com/desktop/desktop/pull/3602 #3602
# e o número do problema ou da solicitação de pull #3602 #3602
GH- e o número do problema ou da solicitação de pull GH-3602 GH-3602
Username/Repository# e o número do problema ou da solicitação de pull desktop/desktop#3602 desktop/desktop#3602

Para obter mais informações, consulte o artigo Referências e URLs automáticas na unidade Resumo deste módulo.

Você pode criar um link para um commit colando a respectiva ID ou, simplesmente, usando o respectivo algoritmo de hash seguro (SHA).

Tipo de referência Referência bruta Link curto
URL da confirmação https://github.com/desktop/desktop/commit/
8304e9c271a5e5ab4fda797304cd7bcca7158c87 8304e9c
SHA 8304e9c271a5e5ab4fda797304cd7bcca7158c87 8304e9c
User@SHA desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87 desktop@8304e9c
Nome de usuário/Repository@SHA desktop/desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87 desktop/desktop@8304e9c

Mencionar usuários e equipes

Digitar um símbolo @ seguido de um nome de usuário do GitHub enviará a essa pessoa uma notificação relativa ao comentário. Isso é chamado de "@mention" e realça o usuário ou a equipe.

@githubteacher

@githubteacher

Monitorar listas de tarefas

Você pode criar listas de tarefas dentro de problemas ou solicitações de pull usando a sintaxe abaixo. Isso pode ser útil para acompanhar o progresso quando usado no corpo de um problema ou solicitação de pull.

- [x] First task
- [x] Second task
- [ ] Third task

Captura de tela de uma lista de tarefas do GitHub.

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 em que há suporte.

Comando Descrição
/code Insere um bloco de código Markdown. Escolha o idioma.
/details Insere uma área de detalhes recolhível. Escolha o título e o conteúdo.
/saved-replies Insere uma resposta salva. Escolha entre as respostas salvas para sua conta de usuário. Se você adicionar %cursor% à sua resposta salva, o comando de barra "/" coloca o cursor nesse local.
/table Insere uma tabela Markdown. Escolha o número de colunas e linhas.
/tasklist Insere uma lista de tarefas. Esse comando barra "/" só funciona em uma descrição do problema.
/template Mostra todos os modelos no repositório. Escolha o modelo a ser inserido. Esse comando de barra funciona para modelos de problemas e para um modelo de solicitação de pull.