Referência de Markdown da plataforma de Q&A da Microsoft

A plataforma de Q&A da Microsoft favorece uma experiência de editor web avançado, para que você nunca precise se preocupar em editar o conteúdo em Markdown. Caso você esteja pensando nisso, aqui está uma referência para escrever em Markdown para o Q&A.

O Markdown é uma linguagem de marcação leve com sintaxe de formatação de texto sem formatação. O learn.microsoft.com (Learn) dá suporte ao Markdown em conformidade com CommonMark analisado por meio do mecanismo de análise Markdig. O Learn e o Q&A também dão suporte a extensões personalizadas do Markdown que fornecem um conteúdo mais avançado no site. O Q&A usa um subconjunto das extensões com suporte na documentação do Learn. Este artigo fornece uma referência em ordem alfabética.

Você pode conferir mais informações no artigo Referência de Markdown no Learn.

Snippets de código

Recurso blockquote (citação)

> This example is a blockquote. It's usually rendered indented and with a different background color.

O exemplo anterior é renderizado da seguinte forma:

Isso é um blockquote. De modo geral é renderizado com um recuo e com uma cor de fundo diferente.

Blocos de códigos

Você pode adicionar linguagem de código a um bloco de código para uma renderização mais avançada.

```csharp
    public static void Log(string message)
            {
                _logger.LogInformation(message);
            }
    ```

O exemplo anterior é renderizado da seguinte forma:

    public static void Log(string message)
            {
                _logger.LogInformation(message);
            }

Emojis

O Q&A converterá um código curto de emoji em seus respectivos caracteres Unicode:

This is a test with a :).

O exemplo anterior é renderizado da seguinte forma:

Esse é um teste com um 😃.

Formatação

Para formatar o texto como negrito, coloque dois asteriscos de cada lado do texto:

This text is **bold**.

Para formatar o texto como itálico, coloque um único asterisco de cada lado do texto:

This text is *italic*.

Para formatar o texto como negrito e itálico, coloque três asteriscos de cada lado do texto:

This text is both ***bold and italic***.

Para formatar o texto como riscado, coloque-o entre dois em acentos "til":

This text is ~~strikeout~~.

Cabeçalhos

O Q&A dá suporte a seis níveis de títulos em Markdown:

# This is a first level heading (H1)

## This is a second level heading (H2)

...

###### This is a sixth level heading (H6)

• É necessário um espaço entre o último # e o texto do cabeçalho.
• Cada pergunta, resposta ou comentário devem ter um e apenas um título H1.

HTML

Se você inserir um conteúdo em HTML, o conteúdo não será renderizado. Em vez disso, será mostrado como texto sem formatação.

Imagens

A extensão :::image::: personalizada do Learn dá suporte a imagens padrão, imagens complexas e ícones.

:::image source="<folderOrURLPath>" alt-text="<alt text>":::

Em que <alt text> é uma breve descrição da imagem e <folderOrURLPath> é um caminho relativo para a imagem ou seu URL. O texto alternativo é obrigatório em leitores de tela para deficientes visuais. Ele também é útil se há um bug de site em que a imagem não pode ser renderizada. Não copie nomes de arquivos para uso como texto alternativo (alt). Por exemplo, em vez disso:

:::image source="./media/bogusfilename/ADextension_2FA_Configure_Step4.PNG" alt-text="ADextension_2FA_Configure_Step4":::

Escreva o seguinte:

:::image source="./media/bogusfilename/ADextension_2FA_Configure_Step4.PNG" alt-text="Active Directory extension for two-factor authentication, step 4: Configure":::

Links

É fácil adicionar links no Q&A. Os links apontam usuários para um conteúdo de outra página no Q&A ou em outra fonte confiável.

[Link text](<FullURL>).

[Microsoft Q&A products page](/answers/products).`

Texto do link

As palavras que você incluir no texto do link devem ser fáceis de entender. Em outras palavras, devem ser palavras normais em português ou o título da página que o link abre.

Não use "selecionar aqui" como "Texto do link". É ruim para a otimização do mecanismo de pesquisa e não descreve adequadamente o destino.

Importante

Todos os links devem ser protegidos (https e não http) quando o destino tiver suporte para eles (a grande maioria tem).

Exemplo:

For more information, see the [Microsoft Q&A products page](/answers/products).

O exemplo acima é renderizado como:

Para obter mais informações, confira a página de produtos do Q&A da Microsoft.

Links automáticos

Os links serão formatados automaticamente para qualquer cadeia de caracteres que comece por: https://, https://, ftp://, mailto:, tel: ou www. (se resolve comohttps://www.)

Listas (numeradas, com marcadores)

Lista numerada

Para criar uma lista numerada, você pode usar 1s para todos os elementos. Os números são renderizados em ordem crescente como uma lista sequencial quando publicados. Para aumentar a legibilidade do código-fonte, você pode aumentar suas listas manualmente.

Não use letras nas listas, incluindo listas aninhadas. Elas não são renderizadas corretamente quando publicadas. As listas aninhadas usando números renderizarão como letras minúsculas quando publicadas. Por exemplo:

1. This is
1. a parent numbered list
   1. and this is
   1. a nested numbered list
1. (fin)

Isso será renderizado da seguinte forma:

1. This is
2. uma lista pai numerada
   1. and this is
   2. a nested numbered list
3. (fin)

Lista com marcadores

Para criar uma lista com marcadores, use - ou * seguido de um espaço no início de cada linha:

- This is
- a parent bulleted list
  - and this is
  - a nested bulleted list
- All done!

Isso será renderizado da seguinte forma:

• This is
• uma lista pai com marcadores
  • and this is
  • a nested bulleted list
• Pronto!

Independentemente da sintaxe que você usar, - ou *, use-a de forma consistente no seu conteúdo.

Tabelas

A maneira mais simples de criar uma tabela em Markdown é usar barras verticais e linhas. Para criar uma tabela padrão com um cabeçalho, siga a primeira linha com uma linha tracejada:

|This is   |a simple   |table header|
|----------|-----------|------------|
|table     |data       |here        |
|it doesn't|actually   |have to line up nicely!|

Isso será renderizado da seguinte forma:

This is	a simple	table header
tabela	data	aqui
it doesn't	actually	have to line up nicely!