Usar Markdown no Azure DevOps

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Este artigo descreve a sintaxe básica para usar o formato Markdown (.md) com recursos do Azure DevOps, incluindo páginas Wiki. A sintaxe markdown permite adicionar formatação especial ao conteúdo da página, como títulos, listas, tabelas e imagens. Use o Markdown para formatar seus arquivos README, dashboards, conteúdo de solicitação de pull e muito mais.

Há duas opções de formatação: convenções comuns do Markdown e extensões markdown para GitHub.

Suporte para recursos do Azure DevOps

A sintaxe markdown permite formatar conteúdo com cabeçalhos, links de referência, texto em negrito e anexos de arquivo. Nem toda sintaxe markdown funciona com todos os recursos no Azure DevOps. Os principais recursos que dão suporte à sintaxe markdown incluem:

• Critérios para a definição de concluído (quadro) para marcos do projeto.
• Metas e métricas da equipe com o widget Markdown.
• Solicitações pull para arquivos de projeto em um repositório Git.
• Arquivos README em um repositório Git para ajudar os colaboradores.
• Arquivos wiki para conteúdo de página em um wiki de projeto de equipe.

A lista a seguir mostra quais elementos Markdown cada funcionalidade suporta e fornece links para seções de sintaxe neste artigo:

Headers

Estruturar seu conteúdo usando cabeçalhos markdown. Cabeçalhos separam partes longas do conteúdo da página em seções mais fáceis de ler. Você pode adicionar cabeçalhos em uma Definição de Concluído (quadro), no Widget de Markdown, nas solicitações pull, nos arquivos Readme e nos arquivos wiki.

Para definir um cabeçalho de nível superior, inicie uma linha com uma única marca # de hash seguida pelo texto do título, como # Get started on the project. Organize suas observações com subtítulos iniciando a linha com mais de uma marca de hash como ## Request permissions ou ### Send feedback. Você pode usar até seis marcas de hash para criar níveis de tamanho de cabeçalhos.

Exemplo: criar cabeçalhos no Markdown

O Markdown a seguir cria um cabeçalho de nível superior (H1) e quatro níveis de subheaders (H2, H3, H4 e H5):

# This is a top-level (H1) header
## This is a subheader (H2)
### This is a lower subheader (H3)
#### This is an H4 header
##### This is an H5 header

A imagem a seguir mostra a exibição publicada do Markdown:

Parágrafos e quebras de linha

Divida seções longas em parágrafos menores ou insira quebras de linha para facilitar a leitura do texto.

Adicione parágrafos e quebras de linha em uma Definição de Concluído (board), o widget Markdown, pull requests, arquivos Readme e arquivos wiki.

Exemplo: adicionar quebras no Markdown e solicitações pull

Os comentários em uma solicitação de pull aceitam Markdown, como estilo Negrito e Itálico para texto. Use a tecla Enter para inserir uma quebra de linha para iniciar um novo texto na próxima linha ou adicionar espaçamento entre linhas.

No Azure DevOps, para criar uma quebra de linha dentro de um parágrafo, adicione dois espaços no final da linha antes de pressionar Enter:

This is the first line with two spaces at the end.  
This is the second line, which will appear directly below the first.

Isso é renderizado como:

Esta é a primeira linha com dois espaços no final.
Esta é a segunda linha, que será exibida diretamente abaixo da primeira.

Se você pressionar Enter sem dois espaços no final, as linhas são combinadas em um único parágrafo na saída publicada.

Para criar um novo parágrafo (com uma linha em branco entre), pressione Enter duas vezes:

This is the first paragraph.

This is the second paragraph.

A imagem a seguir mostra a visualização publicada do Markdown para espaçamento no comentário de uma solicitação pull:

Exemplo: adicionar quebras em arquivos Markdown ou widgets

Em um arquivo Markdown ou widget Markdown, separe linhas de texto para criar novos parágrafos. Adicione dois espaços (tecla Space ) antes da quebra de linha e pressione Enter para iniciar um novo parágrafo.

Add two **Space** characters before the end of the line and then press **Enter**.
The next paragraph starts on a new line. The two paragraphs are separated by a blank line.

A imagem a seguir mostra a visualização publicada do Markdown para o espaçamento em um widget.

Aspas de bloco

Cite comentários ou trechos de texto para definir o contexto para seu próximo comentário ou texto. O texto citado é exibido recuado da margem esquerda com uma linha vertical ao longo da seção citada.

Você pode adicionar citações em bloco em uma Definição de Concluído (board), no Widget de Markdown, nas solicitações pull, nos arquivos Readme e nos arquivos wiki.

Para citar uma única linha de texto ou um bloco de parágrafo, insira um colchete > de ângulo reto antes do primeiro texto.

Para criar uma citação aninhada, insira dois ou mais colchetes antes do texto. A citação aninhada é recuada ainda mais da margem esquerda com linhas verticais duplas ao longo da seção citada.

Exemplo: use colchetes para citar o texto

> Insert a bracket ">" before the text to quote the line of text.

This text references the quoted sentence.

> To quote a paragraph, insert a bracket ">" before the first text. The other lines in the paragraph are also included in the block quote. Notice the entire paragraph is indented from the left margin and highlighted with a vertical line.

This text references the quoted paragraph.

>> Insert two or more brackets ">>" before the text to create a nested quote.

>>> Nested quotes can also be multiple lines of text. Notice the nested quote text is indented further from the left margin and a vertical line is drawn for each level of bracket you insert.

This text references the nested block quotes.

A imagem a seguir mostra a exibição publicada do Markdown para o texto citado:

Regras horizontais

Sublinhar ou separar conteúdo e seções de página com regras horizontais. Você pode adicionar separadores em uma Definição de Concluído (board), no widget Markdown, nas solicitações de pull, nos arquivos readme e nos arquivos wiki.

Para adicionar uma regra horizontal, insira uma linha em branco e, em seguida, outra linha com três hifens (traços). ---

Exemplo: inserir separadores horizontais

O Markdown a seguir cria duas regras horizontais:

Text **above** a horizontal rule
<!-- Blank -->
---
Text **between** horizontal rules
<!-- Blank -->
---
Text **under** a horizontal rule

A imagem a seguir mostra a exibição publicada do Markdown para regras horizontais.

Ênfase (negrito, itálico, tachado)

O Markdown permite enfatizar o texto de várias maneiras:

Combine esses estilos para adicionar ênfase. Você pode usar estilos de ênfase em uma Definição de Concluído (board), no widget Markdown, em pull requests, em arquivos Readme e em arquivos wiki.

Exemplo: Enfatizar texto

Aqui está um Markdown que mostra como enfatizar o texto com estilos diferentes e combinados:

**Italics** highlights text in a larger block like _new terminology_.

**Bold** (strong) adds presence to text, such as **Important!**

**Strikethrough** is useful for corrections like "Send feedback ~~to the team~~."

Combine styles for other effects, such as ~~__Content removed__~~ and **_Milestones_**.

A imagem a seguir mostra a aparência dos estilos de ênfase de texto do Markdown quando publicados:

Realce de código

Realce blocos de texto ou texto embutido como código usando realces de código. Você pode adicionar realce de código em solicitações de pull, arquivos Readme e arquivos wiki.

Para formatar um bloco de texto como código, coloque o bloco dentro de três caracteres de acento grave (```). Os acentos graves que iniciam e terminam a seção devem estar em uma linha separada do bloco de código a ser realçado.

Você também pode formatar uma parte do texto em um bloco de texto maior como um segmento de código embutido. Para esse estilo, insira o código embutido entre um par de acentos graves (`). Os acentos graves estão incorporados ao texto e não em linhas separadas.

O realce de código no widget Markdown renderiza o código como texto pré-formatado.

Exemplo: realçar o bloco de código no widget Markdown

Este exemplo mostra como realçar um bloco de texto como código no widget Markdown:

<!-- ```  Three backticks to start block " -->
sudo npm install vsoagent-installer -g
<!-- ```  Three backticks to end block -->

Este exemplo mostra a visualização publicada do Markdown de um bloco de texto destacado como código:

sudo npm install vsoagent-installer -g

Exemplo: realçar código embutido no widget Markdown

Este exemplo mostra como realçar uma parte do texto como um segmento de código embutido no widget Markdown:

To install the Microsoft Cross Platform Build and Release Agent, run the following: <!-- ` - Single backtick --> $ sudo npm install vsoagent-installer -g <!-- ` - Single backtick -->

Esta imagem mostra a visualização publicada do Markdown para uma porção de texto destacada como código em linha:

Exemplo: Converter texto em código, identificar linguagem de código

Há outra maneira de converter um bloco de texto em código. Quando uma linha de texto no Markdown começa com quatro espaços na margem esquerda, o texto é convertido automaticamente em um bloco de código. Este exemplo demonstra esse comportamento:

    This article is a Markdown file (_.md_). This line of text automatically formats as code because the line starts with four spaces in the left margin.

A abordagem de preferência é colocar o texto entre três acentos graves para que você possa especificar o identificador de idioma. O identificador aplica o realce de sintaxe ao código de acordo com as convenções do idioma especificado. Rótulos de identificador estão disponíveis para a maioria das linguagens de programação, como JavaScript (js), C# (csharp) e Markdown (md). Para obter a lista de idiomas com suporte, consulte o repositório GitHub de highlightjs .

Estes exemplos mostram como identificar um bloco de texto como JavaScript ou C#. Adicione o rótulo do identificador de idioma após os três primeiros caracteres de crase, como em ```md.

JavaScript

<!-- ```js       - Three backticks and identifier 'js' -->
const count = records.length;
<!-- ```         - Three backticks -->

Esta é a exibição publicada do código JavaScript:

const count = records.length;

C#

<!-- ```csharp   - Three backticks and identifier 'csharp' -->
Console.WriteLine("Hello, World!");
<!-- ```         - Three backticks -->

Esta é a exibição publicada do código C#:

Console.WriteLine("Hello, World!");

Sugerir alteração

As solicitações de pull do GitHub dão suporte ao recurso Comentário , que permite que os colaboradores forneçam entradas e sugiram alterações. Adicione um comentário para uma linha específica ou várias linhas em um arquivo. O autor da solicitação de pull aplica a alteração sugerida em um comentário selecionando Aplicar Alteração. Essa ação confirma a alteração na solicitação de pull e inicia um build.

Quando você adiciona um comentário que inclui realce de código no widget Markdown, o código é mostrado em um formato de comparação. As alterações na linha modificada são anotadas para mostrar as diferenças. O símbolo - de subtração indica o conteúdo removido e o símbolo + de adição realça o novo conteúdo.

Exemplo: sugerir alterações em um comentário de solicitação pull

Este exemplo mostra como sugerir alterações de código em uma solicitação de pull no widget Markdown. Nesse cenário, o bloco de código usa o identificador suggestion:

<!-- ```suggestion   - Three backticks and identifier 'suggestion' -->
  for i in range(A, B+100, C):
<!-- ```         - Three backticks -->

A imagem a seguir mostra a visualização de diferenças, incluindo a sugestão de comentário.

Para obter mais informações, consulte Sugerir alterações nos comentários.

Tables

Organize dados estruturados com tabelas markdown. Adicione tabelas no widget Markdown, solicitações de pull, arquivos Readme e arquivos wiki. As tabelas são especialmente úteis para descrever parâmetros de função, métodos de objeto e outros dados com um mapeamento de nome para descrição claro.

Aqui estão alguns pontos sobre como trabalhar com tabelas no Markdown:

• Crie cada linha em uma linha separada e termine cada linha com um CR (retorno de carro) ou LF (feed de linha).
• Crie colunas com hifens - e o símbolo de barra vertical |, como |---|---|---|.
• Defina os cabeçalhos de coluna na primeira linha, como | First | Middle | Last |.
• Defina o alinhamento da coluna (esquerda, centro, direita) usando os dois pontos : na segunda linha, como |:--|:--:|--:|.
• Escape do símbolo de pipe com uma barra invertida \| ao usá-lo no texto da tabela, como | Describe the pipe \| symbol. |
• Adicione quebras de linha dentro de uma célula usando a tag de quebra HTML <br/>. Essa abordagem funciona em um wiki, mas não em outro lugar.
• Adicione um espaço em branco antes e depois de um item de trabalho ou solicitação de pull mencionada no texto da tabela.

Exemplo: criar uma tabela

O exemplo a seguir mostra como criar uma tabela com três colunas e cinco linhas no Markdown:

| Feature | Prerelease | Release target |  
|:---|:---:|---:|
| Calculator | No | 10/27/2025 |
| Graphs | Yes | 8/18/2025 |
| Mail | No | 2/16/2025 |
| Tables | Yes | 10/27/2025 |
| Search | No | 1/5/2026 |

Veja a aparência da tabela Markdown quando publicada:

Lists

Organize os itens relacionados usando diferentes tipos de listas. Use uma lista ordenada para mostrar a ordem ou a sequência de itens. Use pontos de marcador para itens relacionados que não precisam estar em ordem. Adicione estilos de lista em uma Definição de Pronto (board), o widget Markdown, solicitações de pull, arquivos Readme e arquivos wiki.

Aqui estão alguns pontos sobre como trabalhar com listas no Markdown:

• Especifique cada item de lista em uma linha separada.
• Inicie cada item em uma lista ordenada com um número seguido por um período, como 1. First item 1. Next item. o sistema de publicação numera automaticamente a lista.
• Inicie cada item em uma lista não ordenada com um hífen - ou asterisco *, como - First point - Next point.
• Verifique o espaçamento antes e depois das listas em um arquivo ou widget Markdown:
  • Para a primeira lista, adicione uma linha em branco antes e depois da lista.
  • Para listas aninhadas, use o recuo correto. Você não precisa de linhas em branco adicionais antes ou depois de listas aninhadas.

Exemplo: criar uma lista numerada (ordenada)

Este exemplo mostra como criar uma lista numerada para itens em uma sequência usando Markdown:

<!-- Blank -->
1. First step in the procedure.
1. Second step.
1. Third step.
<!-- Blank -->

Aqui está a visualização publicada da lista ordenada por Markdown.

1. Primeira etapa no procedimento.
2. Segunda etapa.
3. Terceira etapa.

Exemplo: criar uma lista com marcadores (não ordenada)

Este exemplo mostra como criar uma lista não ordenada de itens relacionados usando Markdown:

<!-- Blank -->
- First item in the list.
- Next item.
- Last item.
<!-- Blank -->

Aqui está a visualização publicada da lista sem ordenação em Markdown:

• Primeiro item da lista.
• Próximo item.
• Último item.

Exemplo: listas aninhadas

Crie listas dentro de listas e misture os estilos.

Este exemplo mostra como criar uma lista numerada com listas de marcadores aninhadas no Markdown:

<!-- Blank -->
1. First step in the procedure.
   - First item in a nested list.
   - Next item.
   - Last item.
1. Second step.
   - First item in a nested list.
      - First item in a subnested list.
      - Next item.
   - Last item.
1. Third step.
   1. First substep.
   1. Next substep.
   1. Last substep.
<!-- Blank -->

Esta é a vista publicada da lista com listas aninhadas:

1. Primeira etapa no procedimento.
   • Primeiro item em uma lista aninhada.
   • Próximo item.
   • Último item.
2. Segunda etapa.
   • Primeiro item em uma lista aninhada.
     • Primeiro item em uma lista subaninhada.
     • Próximo item.
   • Último item.
3. Terceira etapa.
   1. Primeiro substep.
   2. Próxima subespasta.
   3. Última subespasta.

Links

Vincule itens de trabalho digitando o símbolo de hash # seguido por uma ID do item de trabalho, então selecione o item de trabalho na lista. Adicione diferentes tipos de links em uma Definition of Done (board), o widget Markdown, pull requests, arquivos Readme e arquivos wiki.

Aqui estão alguns pontos sobre como trabalhar com links no Markdown:

• A sintaxe markdown padrão para um link é [Link display text](Link path).

• Em comentários de pull request e wikis, as URLs que começam com HTTP ou HTTPS são formatadas automaticamente como links.

• Se você usar a marca # de hash de outras maneiras, como códigos hexadecimais de cor, poderá evitar sugestões automáticas de itens de trabalho prefixando a marca # de hash com uma barra \ invertida.

• Em arquivos e widgets do Markdown, crie hiperlinks de texto para uma URL usando a sintaxe de link markdown padrão. O Link path pode ser relativo ou absoluto.

  O exemplo a seguir mostra como especificar um link relativo no Markdown. O texto é renderizado como um hiperlink:

  For more information, see the [C# language reference](/dotnet/csharp/language-reference/).
  

  Aqui está a visualização publicada do link:

  Para obter mais informações, consulte a referência de linguagem C#.

Links com suporte

Quando você vincula a outra página markdown no mesmo repositório Git ou TFVC (Team Foundation Version Control), especifique o destino do link como um caminho relativo ou absoluto.

As seções a seguir mostram exemplos para diferentes cenários de Markdown.

Exemplo: links relativos da página de boas-vindas

Aqui estão alguns exemplos de links relativos na página Boas-vindas para um wiki:

• Caminho relativo: [Display text](target.md)

• Caminho absoluto no Git: [Display text](/folder/target.md)

• Caminho absoluto em TFVC: [Display text]($/project/folder/target.md)

• URL: [Display text](http://address.com)

Exemplo: links relativos do widget de markdown

O exemplo a seguir mostra um link relativo em um widget Markdown:

• URL: [Display text](http://address.com)

Exemplo: links relativos de páginas wiki

Aqui estão alguns exemplos de links relativos em uma página wiki:

• Caminho absoluto das páginas wiki: [Display text](/parent-page/child-page)
• URL: [Display text](http://address.com)

Links relativos do controle do código-fonte

Links relativos para arquivos de controle do código-fonte são interpretados de forma diferente em uma página de boas-vindas e em um widget markdown:

Exemplo: links relativos da página de boas-vindas

Links relativos em uma página de boas-vindas são relativos à raiz do repositório de controle do código-fonte em que a página de boas-vindas existe. Aqui estão alguns exemplos:

• /BuildTemplates/AzureContinuousDeploy.11.xaml
• ./page-2.md

Exemplo: links relativos do widget de markdown

Links relativos em um widget Markdown são relativos à base de URL da coleção de projetos de equipe. Aqui estão alguns exemplos:

• /DefaultCollection/Fabrikam/versionControl#path=$/TFVC-Welcome/BuildTemplates/AzureContinuousDeploy.11.xaml
• /DefaultCollection/Fabrikam/versionControl#path=$/TFVC-Welcome/page-2.md

Links de âncora

Quando um arquivo Markdown é renderizado como HTML, o sistema atribui uma ID de âncora a cada cabeçalho na página. O ID é uma forma convertida do texto do cabeçalho. O sistema aplica as seguintes alterações para criar a ID:

• Substituir espaços no texto do cabeçalho por hifens -
• Alterar letras maiúsculas para minúsculas
• Converter a maioria dos caracteres especiais e pontuação em hifens, incluindo :, , ", ?, @, $, #
• Remover ou converter outros caracteres especiais de acordo com as regras do mecanismo de renderização

Use a marca de hash # para vincular ao cabeçalho do documento, como em [Display text](#<header-anchor>).

O exemplo a seguir mostra um título e um link para seu ID de âncora.

#### Team #1 : Release Wiki!

Welcome to the Release wiki. For more information, [Visit the Project Wiki](#team-1--release-wiki).

Aqui está a visualização publicada:

Equipe nº 1: Wiki de lançamentos!

Bem-vindo ao wiki de lançamentos. Para obter mais informações, visite o Wiki do Projeto.

Vincule a um título em outro arquivo Markdown especificando o nome do arquivo com a ID de âncora no link:

[Set up a project wiki](about-readme-wiki.md#set-up-a-project-wiki).

Uma página wiki também é um arquivo Markdown. Faça referência a um título de uma página no wiki a partir de outra página.

Welcome to the Wiki!

- [Get Started](/get-started-page)
- [Contribute content](/get-started-page#contribute)
- [Send Feedback](/contact-page#send-feedback)

Images

Use imagens e GIFs animados para demonstrar conceitos e adicionar interesse visual ao seu conteúdo. Adicione imagens no widget Markdown, solicitações de pull, arquivos Readme e arquivos wiki.

Use a sintaxe markdown padrão para uma imagem ou GIF animado: ![Image alt text](Image path). Essa sintaxe é semelhante a um link, mas a linha começa com um símbolo de ponto ! de exclamação.

Image alt text descreve a imagem e é exibida quando o usuário passa o mouse sobre a imagem no modo de exibição publicado. Image path identifica o local da imagem.

Aqui está um exemplo que adiciona uma ilustração a um arquivo Markdown:

![Illustration to use for new users](https://azurecomcdn.azureedge.net/cvt-779fa2985e70b1ef1c34d319b505f7b4417add09948df4c5b81db2a9bad966e5/images/page/services/devops/hero-images/index-hero.jpg)

Caminho da imagem

O caminho para o arquivo de imagem pode ser um caminho relativo ou um caminho absoluto no Git ou TFVC, assim como o caminho para outro arquivo Markdown em um link.

• Caminho relativo: ![Image alt text](./image.png)
• Caminho absoluto no Git: ![Image alt text](/media/markdown-guidance/image.png)
• Caminho absoluto em TFVC: ![Image alt text]($/project/folder/media/markdown-guidance/image.png)

Tamanho da imagem

Defina o tamanho da imagem com a Image-path =Image-widthxImage-height sintaxe:

• A letra x representa "por" na expressão largura por altura.
• Não adicione um espaço antes ou depois da letra x.
• Inclua um espaço antes do sinal de igual = .
• Para especificar apenas a largura, use Image-path =Image-widthx. Você ainda precisa incluir a letra x.

Aqui está um exemplo de sintaxe markdown para uma imagem com uma largura de 500 e uma altura de 250:

![Image alt text](./image.png =500x250)

Lista de verificação ou lista de tarefas

Acompanhe o progresso de suas atribuições e itens de ação com listas de tarefas leves. Adicione listas de verificação ou listas de tarefas em solicitações de pull e arquivos wiki. Esse recurso é útil na descrição da solicitação de pull para acompanhar a entrada dos revisores ou em uma página do projeto wiki para acompanhar o status da tarefa.

Exemplo: Criar lista de verificação no Markdown

Crie uma lista de verificação diretamente no Markdown:

• Use colchetes vazios [<space>] para criar uma nova tarefa.
• Mostrar uma tarefa como concluída incluindo a letra x dentro dos colchetes [x].
• Preceda cada tarefa com um hífen e espaço -<space>[<space>] ou um número e espaço 1.<space>[<space>]. Utilize qualquer numeral.
• Não use uma lista de verificação dentro de uma tabela Markdown.

O exemplo a seguir cria uma lista de verificação com quatro itens, em que o primeiro item é marcado como concluído:

- [x] Project plan
- [ ] Draft 1 code
- [ ] Draft 2 code
- [ ] Test plan

Aqui está a visualização da lista de verificação publicada.

Depois que a lista de verificação é publicada, os usuários marcam um item como concluído selecionando a caixa de seleção de item na lista.

Exemplo: Aplicar markdown da lista de tarefas ao texto selecionado

Selecione o texto existente no portal da Web e use ações na barra de ferramentas markdown para aplicar o formato de lista de verificação. Depois de adicionar uma lista de verificação ou tarefa dessa maneira, edite a lista ou tarefa no Markdown.

A imagem a seguir mostra como aplicar o estilo lista de tarefas na barra de ferramentas Markdown ao texto selecionado:

Marque uma tarefa como concluída marcando a caixa de tarefas na lista:

Reações de emoji

Adicione reações de emoji em solicitações de pull e arquivos wiki. Use reações de emoji para adicionar caractere e reagir aos comentários na solicitação.

Insira o nome de uma emoção ou expressão como smile e envolva o texto com caracteres de dois-pontos :. No modo de exibição publicado do Markdown, sua entrada é convertida no gráfico de emoji correspondente. O Markdown no Azure DevOps dá suporte à maioria dos elementos gráficos de emoji do GitHub. Ele não dá suporte ao Emoji Personalizado como :bowtie:.

Exemplo: adicionar reações de emoji em uma solicitação de pull

Este exemplo demonstra como adicionar reações de emoji com Markdown em um comentário de pull request:

The code review received :+1::+1: and the team is :smile:

Esta imagem mostra a visualização publicada das reações de emoji:

Exemplo: sintaxe de emoji de escape no Markdown

Este exemplo mostra como escapar da sintaxe de emoji com o caractere de barra \ invertida no Markdown:

Markdown syntax for some emoji reactions:
- **Happy** \:smile:
- **Angry** \:angry:
- **Sad** \:cry:

Esta imagem mostra a exibição publicada do Markdown que mostra a sintaxe de emoji:

Em um comentário de pull request, use duas barras invertidas \\ para evitar a conversão automática dos emojis.

Caracteres especiais como texto literal

Use a barra invertida \ como um caractere de escape no Markdown para publicar caracteres especiais como texto literal. A barra invertida instrui o sistema de publicação a mostrar o caractere especial como texto literal e não a interpretá-lo ou convertê-lo.

Use as sintaxes de ignorar e escapar em uma Definição de Pronto (quadro), o widget Markdown, Pull Requests, arquivos Readme e arquivos wiki.

Exemplo: publicar caracteres especiais

A sintaxe markdown 'Incluir texto em backticks' é mostrada como Enclose text in backticks no modo de exibição publicado. O sistema de publicação aplica o formato inline code ao texto dentro dos backticks (`) e não publica os backticks.

Se você prefixar o backtick (') com uma barra invertida (\), o formato de texto dentro dos backticks não será alterado e os backticks serão publicados. Esse comportamento funciona para a maioria dos caracteres especiais, incluindo parênteses (), colchetes [], sublinhado _, hífen -, hash mark #, asterisco *, backtick ' e a própria barra \ invertida.

O Markdown a seguir usa o caractere de barra invertida para mostrar caracteres \ especiais como texto literal:

\\\ Code comment

Show the **\_\_**underscores**\_\_**

\# Code comment and not a **Heading** 

**\(** Include the **parentheses \)**

Show the __\*__asterisks__\*__ and don't change to *italics*

Aqui está a visualização publicada do Markdown:

\\ Comentário de código

Mostrar o __underlines__

# Comentário de código e não um título

( Incluir os parênteses )

Mostrar os *asteriscos* e não mudar para itálico

Attachments

Anexar arquivos em comentários de solicitações pull e páginas wiki. Anexos podem ajudar a ilustrar seu ponto ou fornecer detalhes sobre suas sugestões. Os anexos dão suporte aos seguintes formatos de arquivo:

Anexar imagens ou arquivos

Você pode anexar uma imagem ou arquivo em uma caixa de comentário de solicitação pull ou em uma página wiki no painel Editar de várias maneiras:

• Arraste um arquivo para o comentário ou para a página wiki.

• Cole uma imagem da área de transferência no comentário ou na página wiki. A imagem é mostrada diretamente no comentário ou na página wiki.

• Selecione o ícone Anexar (paperclip) no comentário ou no painel Formatar na página wiki e escolha o arquivo a ser anexado:

  

Quando você anexa um arquivo não imagem, o sistema cria um link para o arquivo no comentário ou na página wiki. Altere o texto de exibição do link dentro dos colchetes, como em [Updated link display text](LINK URL). Quando você publica a página ou o comentário, o usuário seleciona o link para acessar o anexo.

Notação matemática e caracteres

Você pode usar notação matemática e caracteres em comentários de solicitação de pull e arquivos wiki. Há suporte para a notação KaTeX embutida e de bloco, que inclui os seguintes elementos:

• Symbols
• Letras gregas
• Operadores matemáticos
• Poderes e índices
• Frações e binomiais
• Outros elementos com suporte do KaTeX

Em um arquivo Markdown, a notação matemática é colocada entre sinais de dólar $ . Para criar uma expressão embutida entre outros textos, coloque a notação entre sinais de dólar únicos. $ A + B = C $ Para uma expressão de bloco, inicie e finalize o bloco com dois sinais de dólar, $$ A = 1 \ B = 2 \ C = A + B $$.

Exemplo: listar caracteres gregos

O exemplo a seguir lista os caracteres gregos usados na notação matemática adicionando um snippet de código no arquivo Markdown. Observe que o identificador de idioma do snippet é KaTeX e não Markdown md:

$
\alpha, \beta, \gamma, \delta, \epsilon, \zeta, \eta, \theta, \kappa, \lambda, \mu, \nu, \omicron, \pi, \rho, \sigma, \tau, \upsilon, \phi, ...
$  

$\Gamma,  \Delta,  \Theta, \Lambda, \Xi, \Pi, \Sigma, \Upsilon, \Phi, \Psi, \Omega$

Esta é a vista publicada dos caracteres gregos:

Exemplo: usar notação algébrica

O exemplo a seguir usa uma notação embutida e uma expressão de bloco algébrico:

Area of a circle is $\pi r^2$

And, the area of a triangle is:

$$
A_{triangle}=\frac{1}{2}({b}\cdot{h})
$$

Aqui está a exibição publicada da notação no arquivo Markdown:

Exemplo: mostrar somas e integrais

O exemplo a seguir usa duas expressões de bloco para calcular somas e integrais:

$$
\sum_{i=1}^{10} t_i
$$

$$
\int_0^\infty \mathrm{e}^{-x}\,\mathrm{d}x
$$     

Aqui está a exibição publicada das expressões no arquivo Markdown:

Markdown em um wiki do Azure DevOps

Há várias maneiras de usar o Markdown para aprimorar o wiki do Azure DevOps. As seções a seguir fornecem exemplos de sintaxe para várias tarefas:

• Adicionar diagramas Mermaid, como sequências, fluxogramas e percursos do usuário
• Criar um TOC (Tabela de Conteúdo) para páginas e subpáginas
• Configurar seções de página colapsáveis
• Inserir vídeos e resultados da consulta do Azure Boards
• Link para itens de trabalho com a marca de hash #
• Usar menções @<alias> para usuários e grupos
• Incluir elementos HTML como <font> para rich text
• Checar a contagem de visitas à página

A disponibilidade desses recursos depende da sua versão do Azure DevOps.

::: mermaid
<diagram type>
   <diagam information>
:::

::: mermaid
sequenceDiagram
    Christie->>Josh: Hello Josh, how are you?
    Josh-->>Christie: Great!
    Christie->>Josh: See you later!
:::

::: mermaid
gantt
    title A Gantt chart
    dateFormat YYYY-MM-DD
    excludes 2022-03-16,2022-03-18,2022-03-19
    section Section

    A task          :a1, 2022-03-07, 7d
    Another task    :after a1 , 5d
:::

:::mermaid
graph LR;
    A[Hard edge] -->|Link text| B(Round edge) --> C{Decision}
    C -->|One| D[Result one]
    C -->|Two| E[Result two]
:::

:::mermaid
classDiagram
    Creature <|-- Superman
    Creature <|-- Vampire
    Creature <|-- Diavolo
    Creature: +int size
    Creature: +int weight
    Creature: +isBenign()
    Creature: +power()
    class Superman{
        +String currentName
        +fly()
        +heal()
    }
    class Vampire{
        -int age
        -canBite()
    }
    class Diavolo{
        +bool is_serving
        +heat()
    }
:::

:::mermaid
stateDiagram-v2
    [*] --> Active
    state Active {
        [*] --> NumLockOff
        NumLockOff --> NumLockOn : EvNumLockPressed
        NumLockOn --> NumLockOff : EvNumLockPressed
        --
        [*] --> CapsLockOff
        CapsLockOff --> CapsLockOn : EvCapsLockPressed
        CapsLockOn --> CapsLockOff : EvCapsLockPressed
        --
        [*] --> ScrollLockOff
        ScrollLockOff --> ScrollLockOn : EvScrollLockPressed
        ScrollLockOn --> ScrollLockOff : EvScrollLockPressed
    }
:::

:::mermaid
journey
    title Home office day
    section Go to work
      Wake up: 1: Me, Dog
      Take shower: 2: Me
      Go downstairs: 3: Me, Dog
      Make coffee: 4: Me
      Have a breakfast: 5: Me, Dog
      Go upstairs: 3: Me, Dog
      Do work: 1: Me, Dog
    section Go home
      Go downstairs: 3: Me, Dog
      Sit down: 5: Me
:::

:::mermaid
pie title Fishermen in countries
    "Norway" : 684
    "Sweeden" : 234
    "Switzerland" : 10
:::

:::mermaid
requirementDiagram
    requirement development_req {
    id: 1
    text: requirements spec.
    risk: medium
    verifymethod: test
    }
    element test_suite {
    type: manual test
    }
    test_suite - verifies -> development_req
:::

::: mermaid
gitGraph
  commit id: "Initial commit"
  branch develop
  commit id: "Develop commit 1"
  commit id: "Develop commit 2"
  checkout main
  commit id: "Main commit 1"
  merge develop id: "Merge develop into main"
  branch feature
  checkout feature
  commit id: "Feature commit 1"
  checkout develop
  commit id: "Develop commit 3"
  checkout feature
  merge develop id: "Merge develop into feature"
:::

::: mermaid
erDiagram
  CUSTOMER {
    string name
    string address
  }
  ORDER {
    int orderNumber
    string product
  }
  CUSTOMER ||--o{ ORDER : places
:::

::: mermaid
timeline
  title Project Development Timeline
  section Planning
    Project kickoff : 2025-01-01
    Requirements gathering : 2025-01-15
  section Development
    Initial development : 2025-02-01
    First prototype : 2025-03-01
  section Testing
    Alpha testing : 2025-04-01
    Beta testing : 2025-05-01
  section Release
    Public release : 2025-06-01
:::

# A collapsible section with Markdown syntax
<details>
  <summary>Click to expand!</summary>

  ## Heading
  1. A numbered
  2. list
     * With some
     * Sub bullets
</details>

Watch the following video:

::: video
<iframe width="640" height="360" src="https://www.youtube.com/embed/OtqFyBA6Dbk" allowfullscreen style="border:none"></iframe>
:::

Results from the Azure Boards query:

:::
query-table 6ff7777e-8ca5-4f04-a7f6-9e63737dddf7
:::

Marcas HTML em páginas wiki

Crie conteúdo avançado usando marcas HTML em páginas wiki, como <font> e <span>. No Azure DevOps Server 2019.1 e posterior, você também pode colar conteúdo avançado como imagens e vídeo como HTML.

Exemplo: usar a sintaxe de Markdown dentro de HTML

O exemplo a seguir mostra como usar a sintaxe Markdown dentro de um elemento HTML em uma página wiki. Adicione uma linha em branco após o elemento HTML de abertura e antes do Markdown:

<p>

This article describes how to **get started** with an Azure DevOps wiki.

For more information, see the [Wikis, search, & navigation documentation](https://learn.microsoft.com/azure/devops/project/) for Azure DevOps.
</p>

Exemplo: inserir um vídeo com HTML

O exemplo a seguir mostra como inserir um vídeo em uma página wiki usando o <video> elemento HTML com uma URL no vídeo:

<video src="https://sec.ch9.ms/ch9/7247/7c8ddc1a-348b-4ba9-ab61-51fded6e7247/vstswiki_high.mp4" width=400 controls>
</video>

Exemplo: usar o formato rich text

O exemplo a seguir mostra como usar o formato de rich text HTML em uma página wiki:

<p>This text needs to <del>strikethrough</del> <ins>since it is redundant</ins>!</p>
<p><tt>This text is teletype text.</tt></p>
<font color="blue">Colored text</font>
<center>This text is center-aligned.</center>
<p>This text contains <sup>superscript</sup> text.</p>
<p>This text contains <sub>subscript</sub> text.</p>
<p>The project status is <span style="color:green;font-weight:bold">GREEN</span> even though the bug count / developer might be shown as <span style="color:red;font-weight:bold">red.</span> - Capability of span
<p><small>Disclaimer: Wiki also supports showing small text</small></p>
<p><big>Bigger text</big></p>

A imagem a seguir mostra a exibição publicada do conteúdo de rich text HTML em uma página wiki, conforme mostrado no modo de exibição de tema Light padrão:

Aqui está a mesma página publicada no modo de exibição de tema escuro:

Conteúdo relacionado

• Página do projeto ou páginas de boas-vindas
• Catálogo de widgets
• Adicionar e editar páginas wiki