Partager via


Utiliser Markdown dans Azure DevOps

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

Important

Sélectionner une version à partir du sélecteur de version de contenu Azure DevOps.

Sélectionnez la version de cet article qui correspond à votre plateforme et à votre version. Le sélecteur de version se trouve au-dessus de la table des matières. Recherchez votre plateforme et votre version Azure DevOps.

Cet article décrit la syntaxe de base pour l’utilisation du format Markdown (.md) avec les fonctionnalités Azure DevOps, y compris les pages Wiki. La syntaxe Markdown vous permet d’ajouter une mise en forme spéciale à votre contenu de page, comme les titres, les listes, les tableaux et les images. Utilisez Markdown pour mettre en forme vos fichiers README, tableaux de bord, contenu de pull request et bien plus encore.

Il existe deux options de mise en forme : les conventions Markdown courantes et les extensions Markdown pour GitHub.

Prise en charge des fonctionnalités Azure DevOps

La syntaxe Markdown vous permet de mettre en forme du contenu avec des en-têtes, des liens de référence, du texte en gras et des pièces jointes de fichier. La syntaxe Markdown ne fonctionne pas avec toutes les fonctionnalités d’Azure DevOps. Les principales fonctionnalités qui prennent en charge la syntaxe Markdown sont les suivantes :

Note

Markdown dans Azure DevOps ne prend pas en charge JavaScript ou les iframes. Par exemple, vous ne pouvez pas incorporer d’éléments interactifs comme les minuteurs de compte à rebours.

La liste suivante montre les éléments Markdown pris en charge par chaque fonctionnalité et les liens vers les sections de syntaxe de cet article :

Type Markdown Done Widget PR README Wiki
Headers
Paragraphes et sauts de ligne
Guillemets de bloc
Règles horizontales
Emphasis
Mise en surbrillance du code
Suggérer une modification
Tables
Lists
Links
Images
Liste de vérification ou de tâches
Emojis
Ignorer ou échapper au Markdown
Attachments
Notation mathématique

Headers

Structurez votre contenu à l’aide d’en-têtes Markdown. Les en-têtes séparent les parties longues du contenu de la page en sections plus faciles à lire. Vous pouvez ajouter des en-têtes dans une Définition de Terminé (tableau), le widget Markdown, les demandes de tirage, les fichiers Readme et les fichiers wiki.

Pour définir un en-tête de niveau supérieur, démarrez une ligne avec une seule marque de hachage # suivie du texte du titre, tel que # Get started on the project. Organisez vos remarques avec des sous-têtes en commençant la ligne avec plusieurs marques de hachage comme ## Request permissions ou ### Send feedback. Vous pouvez utiliser jusqu’à six marques de hachage pour créer des niveaux de taille d’en-têtes.

Exemple : Créer des en-têtes dans Markdown

Le markdown suivant crée un en-tête de niveau supérieur (H1) et quatre niveaux de sous-têtes (H2, H3, H4 et 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

L’image suivante montre la vue publiée de Markdown :

Capture d’écran de la vue publiée de la syntaxe Markdown pour cinq niveaux d’en-têtes.

Paragraphes et sauts de ligne

Important

Azure DevOps Markdown gère les sauts de ligne différemment de la plupart des autres implémentations Markdown. Pour créer un saut de ligne (retour réversible) dans un paragraphe, ajoutez deux espaces à la fin de la ligne avant d’appuyer sur Entrée. Si vous appuyez sur Entrée sans les deux espaces, la sortie publiée n’inclut pas de saut de ligne.

Décomposez les sections longues en paragraphes plus petits ou insérez des sauts de ligne pour faciliter la lecture de votre texte.

Ajoutez des paragraphes et des sauts de ligne dans une définition de terminé (tableau), le widget Markdown, les pull requests, les fichiers Readme et les fichiers wiki.

Exemple : Ajouter des sauts de ligne dans Markdown et des pull requests

Les commentaires d’une demande de tirage acceptent Markdown, comme le style Gras et Italique pour le texte. Utilisez la touche Entrée pour insérer un saut de ligne pour démarrer un nouveau texte sur la ligne suivante ou ajouter un espacement entre les lignes.

Dans Azure DevOps, pour créer un saut de ligne dans un paragraphe, ajoutez deux espaces à la fin de la ligne avant d’appuyer sur Entrée :

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

Cela s’affiche comme suit :

Il s’agit de la première ligne avec deux espaces à la fin.
Il s’agit de la deuxième ligne, qui s’affiche directement sous la première.

Si vous appuyez sur Entrée sans deux espaces de fin, les lignes se combinent en un seul paragraphe dans la sortie publiée.

Pour créer un paragraphe (avec une ligne vide entre), appuyez deux fois sur Entrée :

This is the first paragraph.

This is the second paragraph.

L’image suivante montre la vue publiée du Markdown pour l’espacement dans un commentaire de demande de tirage :

Capture d’écran de la vue publiée de la syntaxe Markdown pour les sauts de ligne et de paragraphe dans un commentaire de pull request.

Exemple : Ajouter des sauts de ligne dans les fichiers ou les widgets Markdown

Dans un fichier Markdown ou un widget Markdown, séparez les lignes de texte pour créer de nouveaux paragraphes. Ajoutez deux espaces (touche Espace ) avant le saut de ligne, puis appuyez sur Entrée pour démarrer un nouveau paragraphe.

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.

L’image suivante montre la vue publiée de Markdown pour l’espacement dans un widget :

Capture d’écran de la vue publiée de la syntaxe Markdown pour les touches Entrée et Espace dans un widget.

Guillemets de bloc

Citez des commentaires ou du texte pour définir le contexte de votre nouveau commentaire ou texte. Le texte cité est indenté à partir de la marge gauche avec une ligne verticale longeant la section citée.

Vous pouvez ajouter des citations dans une Définition de Terminé (tableau), le widget Markdown, les demandes de tirage, les fichiers Readme et les fichiers wiki.

Pour citer une seule ligne de texte ou un bloc de paragraphe, insérez un crochet > à angle droit avant le premier texte.

Pour créer un guillemet imbriqué, insérez deux crochets ou plus avant le texte. Le guillemet imbriqué est mis en retrait plus loin de la marge gauche avec des lignes verticales doubles le long de la section entre guillemets.

Exemple : Citer du texte en utilisant des crochets

> 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.

L’image suivante montre la vue publiée de Markdown pour le texte entre guillemets :

Capture d’écran de la vue publiée de la syntaxe Markdown pour citer des blocs de texte.

Règles horizontales

Soulignez ou séparez les sections de contenu et de page avec des règles horizontales. Vous pouvez ajouter des séparateurs dans une Définition de Fait (tableau), le widget Markdown, les requêtes d'extraction, les fichiers README et les fichiers wiki.

Pour ajouter une règle horizontale, entrez une ligne vide, puis une autre ligne avec trois traits d’union (tirets). ---

Exemple : Insérer des séparateurs horizontaux

Le markdown suivant crée deux règles horizontales :

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

L’image suivante montre la vue publiée de Markdown pour les règles horizontales.

Capture d’écran de la vue publiée de la syntaxe Markdown pour les règles horizontales.

Accentuation (gras, italique, barré)

Markdown vous permet de mettre en évidence le texte de plusieurs façons :

Style Example Markdown
Italics Texte italique Placez le texte dans un seul astérisque * ou caractère de soulignement _ .
Gras (fort) Texte en gras Placez le texte entre des doubles astérisques ** ou des soulignés __.
Strikethrough Texte barré Placez le texte dans des tildes ~~doubles.

Combinez ces styles pour ajouter de l’accentuation. Vous pouvez utiliser des styles d’accentuation dans une Definition of Done (tableau), le widget Markdown, les pull requests, les fichiers Readme et les fichiers wiki.

Note

Markdown n’a pas de syntaxe pour le texte en soulignement. Dans une page wiki, vous pouvez souligner du texte à l’aide de l’élément de soulignement <u> HTML.

Exemple : Mettre en évidence le texte

Voici quelques markdown qui montrent comment mettre en évidence du texte avec des styles différents et combinés :

**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_**.

L’image suivante montre comment les styles d’accentuation du texte Markdown s’affichent lors de la publication :

Capture d’écran de la vue publiée des styles d’accentuation de texte Markdown.

Mise en surbrillance du code

Mettez en évidence des blocs de texte ou du texte inline comme du code en utilisant des mises en forme de code. Vous pouvez ajouter la mise en surbrillance de code dans les pull requests, les fichiers Readme et les fichiers wiki.

Pour mettre en forme un bloc de texte en tant que code, placez le bloc dans trois caractères guillemets inversés (```). Les accents graves qui commencent et terminent la section doivent se trouver sur une ligne distincte du bloc de code à mettre en évidence.

Vous pouvez également mettre en forme une partie du texte dans un bloc de texte plus grand en tant que segment de code inline. Pour ce style, entourez le code inline avec un seul accent grave. Les accents graves sont placés sur la même ligne que le texte et non sur des lignes distinctes.

La mise en surbrillance du code dans le widget Markdown restitue le code sous forme de texte préformaté brut.

Exemple : Mettre en surbrillance le bloc de code dans le widget Markdown

Cet exemple montre comment mettre en surbrillance un bloc de texte en tant que code dans le widget Markdown :

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

Cet exemple montre la vue publiée de Markdown pour un bloc de texte mis en surbrillance en tant que code :

sudo npm install vsoagent-installer -g

Exemple : mettre en surbrillance le code inline dans le widget Markdown

Cet exemple montre comment mettre en surbrillance une partie du texte en tant que segment de code inline dans le 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 -->

Cette image montre la vue publiée de Markdown pour une partie du texte mis en surbrillance en tant que segment de code inline :

Capture d’écran montrant une vue publiée de la syntaxe Markdown pour une partie de texte mise en surbrillance en tant que segment de code inline.

Exemple : Convertir du texte en code, identifier la langue du code

Il existe une autre façon de convertir un bloc de texte en code. Lorsqu’une ligne de texte dans Markdown commence par quatre espaces dans la marge gauche, le texte se convertit automatiquement en bloc de code. Cet exemple illustre ce comportement :

    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.

L’approche recommandée consiste à entourer le texte avec trois accents graves afin de pouvoir spécifier l’identificateur de langage. L’identificateur applique la mise en surbrillance de la syntaxe au code en fonction des conventions du langage spécifié. Les étiquettes d’identificateur sont disponibles pour la plupart des langages de programmation, tels que JavaScript (js), C# (csharp) et Markdown (md). Pour obtenir la liste des langues prises en charge, consultez le dépôt GitHub highlightjs .

Ces exemples montrent comment identifier un bloc de texte en JavaScript ou C#. Ajoutez l’étiquette d’identificateur de langue après les trois premiers backticks, comme dans ```md.

JavaScript

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

Il s’agit de la vue publiée du code JavaScript :

const count = records.length;

C#

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

Voici l’affichage publié du code C# :

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

Suggérer une modification

Les requêtes de tirage GitHub prennent en charge la fonctionnalité Commentaire, qui permet aux contributeurs d'apporter des commentaires et de suggérer des modifications. Ajoutez un commentaire pour une ligne spécifique ou plusieurs lignes dans un fichier. L’auteur de la pull request applique la modification suggérée dans un commentaire en sélectionnant Appliquer la modification. Cette action valide la modification apportée à la pull request et démarre une compilation.

Lorsque vous ajoutez un commentaire qui inclut la mise en surbrillance du code dans le widget Markdown, le code s’affiche dans un format de différences. Les modifications apportées à la ligne modifiée sont annotées pour afficher les différences. Le symbole - moins indique le contenu supprimé et le symbole + plus met en surbrillance le nouveau contenu.

Exemple : Suggérer des changements dans un commentaire de pull request

Cet exemple montre comment suggérer des modifications de code sur une pull request dans le widget Markdown. Dans ce scénario, le bloc de code utilise l’identificateur suggestion:

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

L’image suivante montre la vue des différences avec la suggestion de commentaire.

Capture d’écran d’une modification suggérée pour le code dans un commentaire de pull request.

Pour plus d’informations, consultez Suggérer des modifications dans les commentaires.

Tables

Organisez des données structurées avec des tables Markdown. Ajoutez des tableaux dans le widget Markdown, les pull requests, les fichiers Readme et les fichiers wiki. Les tables sont particulièrement utiles pour décrire les paramètres de fonction, les méthodes d’objet et d’autres données avec un mappage de nom à description clair.

Voici quelques points sur l’utilisation des tables dans Markdown :

  • Créez chaque ligne sur une ligne distincte et terminez-la avec un retour chariot (CR) ou un saut de ligne (LF).
  • Créez des colonnes avec des traits d’union - et le symbole |de canal, comme |---|---|---|.
  • Définissez les en-têtes de colonne dans la première ligne, par exemple | First | Middle | Last |.
  • Définissez l’alignement des colonnes (gauche, centre, droite) à l’aide de deux-points : dans la deuxième ligne, par exemple |:--|:--:|--:|.
  • Échappez le symbole pipe avec une barre oblique inverse \| lorsque vous l’utilisez dans le texte du tableau, par exemple | Describe the pipe \| symbol. |
  • Ajoutez des sauts de ligne dans une cellule à l’aide de la balise HTML de saut de ligne <br/>. Cette approche fonctionne dans un wiki, mais pas ailleurs.
  • Ajoutez un espace vide avant et après un élément de travail ou une pull request mentionnée dans le texte du tableau.

Exemple : Créer une table

L’exemple suivant montre comment créer une table avec trois colonnes et cinq lignes dans 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 |

Voici l’apparence de la table Markdown lors de la publication :

Feature Prerelease Cible de mise en production
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

Lists

Organisez les éléments associés à l’aide de différents types de listes. Utilisez une liste ordonnée pour afficher l’ordre ou la séquence d’éléments. Utilisez des points à puces pour les éléments associés qui n’ont pas besoin d’être dans l’ordre. Ajoutez des styles de liste dans une Définition du Terminé (tableau), le widget Markdown, les pull requests, les fichiers README et les fichiers wiki.

Voici quelques points sur l’utilisation des listes dans Markdown :

  • Spécifiez chaque élément de liste sur une ligne distincte.
  • Démarrez chaque élément d’une liste triée avec un nombre suivi d’une période, comme 1. First item 1. Next item. le système de publication numérote automatiquement la liste.
  • Démarrez chaque élément d’une liste non ordonnée avec un trait - d’union ou un astérisque *, comme - First point - Next point.
  • Vérifiez l’espacement avant et après les listes dans un fichier ou widget Markdown :
    • Pour la première liste, ajoutez une ligne vide avant et après la liste.
    • Pour les listes imbriquées, utilisez la mise en retrait correcte. Vous n’avez pas besoin de sauts de ligne supplémentaires avant ou après les listes imbriquées.

Exemple : Créer une liste numérotée (ordonnée)

Cet exemple montre comment créer une liste numérotée pour les éléments d’une séquence à l’aide de Markdown :

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

Voici la vue publiée de la liste triée Markdown :

  1. Première étape de la procédure.
  2. Deuxième étape.
  3. Troisième étape.

Exemple : Créer une liste à puces (non ordonnée)

Cet exemple montre comment créer une liste non ordonnée d’éléments associés à l’aide de Markdown :

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

Voici la vue publiée de la liste non triée Markdown :

  • Premier élément de la liste.
  • Élément suivant.
  • Dernier élément.

Exemple : listes imbriquées

Créez des listes dans des listes et mélangez les styles.

Cet exemple montre comment créer une liste numérotée avec des listes à puces imbriquées dans 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 -->

Voici la vue publiée de la liste avec des listes imbriquées :

  1. Première étape de la procédure.
    • Premier élément d’une liste imbriquée.
    • Élément suivant.
    • Dernier élément.
  2. Deuxième étape.
    • Premier élément d’une liste imbriquée.
      • Premier élément d’une sous-liste.
      • Élément suivant.
    • Dernier élément.
  3. Troisième étape.
    1. Premier sous-étape.
    2. Sous-étape suivante.
    3. Dernier sous-étape.

Lien vers les éléments de travail en entrant la marque # de hachage suivie d’un ID d’élément de travail, puis sélectionnez l’élément de travail dans la liste. Ajoutez différents types de liens dans une Definition of Done (board), le widget Markdown, les pull requests, les fichiers README et les fichiers wiki.

Voici quelques points sur l’utilisation de liens dans Markdown :

  • La syntaxe Markdown standard pour un lien est [Link display text](Link path).

  • Dans les commentaires de pull request et les wikis, les URL qui commencent par HTTP ou HTTPS sont automatiquement formatées comme des liens.

  • Si vous utilisez le signe dièse # d'autres façons, comme les codes hexadécimaux de couleur, vous pouvez éviter les suggestions automatiques pour les éléments de travail en préfixant le signe dièse # avec une barre oblique inverse \.

  • Dans les fichiers et widgets Markdown, créez des liens hypertexte de texte pour une URL à l’aide de la syntaxe de lien Markdown standard. Link path peut être relatif ou absolu.

    L’exemple suivant montre comment spécifier un lien relatif dans Markdown. Le texte s’affiche sous la forme d’un lien hypertexte :

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

    Voici la vue publiée du lien :

    Pour plus d’informations, consultez la référence du langage C#.

Lorsque vous créez un lien vers une autre page Markdown dans le même référentiel Git ou Team Foundation Version Control (TFVC), spécifiez la cible de lien comme chemin relatif ou absolu.

Note

Les liens vers des documents sur des partages de fichiers (file://...) ne sont pas pris en charge pour des raisons de sécurité.

Les sections suivantes présentent des exemples pour différents scénarios Markdown.

Voici quelques exemples de liens relatifs dans la page d’accueil d’un wiki :

  • Chemin relatif : [Display text](target.md)

  • Chemin absolu dans Git : [Display text](/folder/target.md)

  • Chemin absolu dans le TFVC : [Display text]($/project/folder/target.md)

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

L’exemple suivant montre un lien relatif dans un widget Markdown :

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

Voici quelques exemples de liens relatifs dans une page wiki :

  • Chemin absolu des pages wiki : [Display text](/parent-page/child-page)
  • URL : [Display text](http://address.com)

Les liens relatifs vers les fichiers de contrôle de code source sont interprétés différemment dans une page d’accueil et un widget Markdown :

Les liens relatifs d’une page d’accueil sont relatifs à la racine du référentiel de contrôle de code source où existe la page d’accueil. Voici quelques exemples :

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

Les liens relatifs dans un widget Markdown sont relatifs à la base d’URL de collection de projets d’équipe. Voici quelques exemples :

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

Lorsqu’un fichier Markdown s’affiche en html, le système affecte un ID d’ancrage à chaque en-tête de la page. L’ID est une forme convertie du texte d’en-tête. Le système applique les modifications suivantes pour créer l’ID :

  • Remplacer des espaces dans le texte d’en-tête par des traits d’union -
  • Modifier les lettres majuscules en minuscules
  • Convertir la plupart des caractères spéciaux et la ponctuation en traits d’union, y compris :, , "?, @, , , $#
  • Supprimer ou convertir d’autres caractères spéciaux en fonction des règles du moteur de rendu

Utilisez la marque # de hachage pour créer un lien vers l’en-tête du document, comme dans [Display text](#<header-anchor>).

L’exemple suivant montre un titre et un lien vers son ID d’ancrage :

#### Team #1 : Release Wiki!

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

Voici la vue publiée :

Équipe #1 : Publier wiki !

Bienvenue dans le wiki Release. Pour plus d’informations, consultez le Wiki du projet.

Conseil / Astuce

Pour déterminer l’ID d’ancrage exact d’un en-tête, inspectez le code HTML rendu ou utilisez les outils de développement du navigateur pour rechercher l’attribut réel id affecté à l’élément d’en-tête.

Lien vers un titre dans un autre fichier Markdown en spécifiant le nom du fichier avec l’ID d’ancrage dans le lien :

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

Une page wiki est également un fichier Markdown. Référencez un titre dans une page du wiki à partir d’une autre page :

Welcome to the Wiki!

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

Images

Utilisez des images et des GIF animées pour illustrer les concepts et ajouter un intérêt visuel à votre contenu. Ajouter des images au widget Markdown, aux pull requests, aux fichiers Readme et aux fichiers wiki.

Utilisez la syntaxe Markdown standard pour une image ou un GIF animé : ![Image alt text](Image path). Cette syntaxe est similaire à un lien, mais la ligne commence par un symbole de point ! d’exclamation.

Image alt text décrit l’image et s’affiche lorsque l’utilisateur pointe sur l’image dans la vue publiée. Image path identifie l’emplacement de l’image.

Voici un exemple qui ajoute une illustration à un fichier Markdown :

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

Chemin d’accès à l’image

Le chemin d’accès au fichier image peut être un chemin relatif ou un chemin absolu dans Git ou TFVC, comme le chemin d’accès à un autre fichier Markdown dans un lien.

  • Chemin relatif : ![Image alt text](./image.png)
  • Chemin absolu dans Git : ![Image alt text](/media/markdown-guidance/image.png)
  • Chemin absolu dans le TFVC : ![Image alt text]($/project/folder/media/markdown-guidance/image.png)

Taille de l’image

Définissez la taille de l’image avec la Image-path =Image-widthxImage-height syntaxe :

  • La lettre x représente le « by » dans l’expression width-by-height.
  • N’ajoutez pas d’espace avant ou après la lettre x.
  • Incluez un espace avant le signe égal = .
  • Pour spécifier uniquement la largeur, utilisez Image-path =Image-widthx. Vous devez toujours inclure la lettre x.

Voici un exemple de syntaxe Markdown pour une image avec une largeur de 500 et une hauteur de 250 :

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

Liste de vérification ou de tâches

Suivez la progression de vos affectations et éléments d’action avec des listes de tâches légères. Ajoutez des listes de vérification ou des listes de tâches dans les pull requests et les fichiers wiki. Cette fonctionnalité est utile dans la description de la pull request pour suivre les commentaires des réviseurs ou sur une page de projet wiki pour suivre l’état des tâches.

Exemple : Créer une liste de contrôle dans Markdown

Créez une liste de contrôle directement dans markdown :

  • Utilisez des crochets vides [<space>] pour créer une tâche.
  • Afficher une tâche comme terminée en incluant la lettre x entre crochets [x].
  • Précèdez chaque tâche avec un trait d’union et un espace -<space>[<space>] ou un nombre et un espace 1.<space>[<space>]. Utilisez n’importe quel chiffre.
  • N’utilisez pas de liste de contrôle dans une table Markdown.

L’exemple suivant crée une liste de contrôle avec quatre éléments, où le premier élément est marqué comme terminé :

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

Voici l’affichage publié de la liste de contrôle :

Capture d’écran montrant une liste de contrôle où le premier élément est marqué comme terminé.

Une fois la liste de contrôle publiée, les utilisateurs marquent un élément comme terminé en cochant la case à cocher de l’élément dans la liste.

Exemple : Appliquer la liste des tâches Markdown au texte sélectionné

Sélectionnez du texte existant dans le portail web et utilisez des actions dans la barre d’outils Markdown pour appliquer le format de liste de contrôle. Après avoir ajouté une liste de contrôle ou une tâche de cette façon, modifiez la liste ou la tâche dans Markdown.

L’image suivante montre comment appliquer le style de liste des tâches dans la barre d’outils Markdown au texte sélectionné :

Capture d’écran montrant comment appliquer le style de Liste des tâches dans la barre d’outils Markdown au texte sélectionné dans une pull request.

Marquez une tâche comme terminée en cochant la zone de tâche dans la liste :

Capture d’écran montrant les tâches marquées comme terminées dans la liste des tâches.

Réactions emoji

Ajoutez des réactions emoji dans les demandes de tirage et les fichiers wiki. Utilisez des réactions emoji pour ajouter un caractère et réagir aux commentaires dans la demande.

Entrez le nom d’une émotion ou d’une expression comme smile et placez le texte dans les caractères deux-points : . Dans la vue publiée de Markdown, votre entrée est convertie en graphique emoji correspondant. Markdown dans Azure DevOps prend en charge la plupart des graphiques emoji GitHub. Il ne prend pas en charge l’Emoji personnalisé comme :bowtie:.

Exemple : Ajouter des réactions emoji dans une demande de tirage

Cet exemple montre comment ajouter des réactions avec emoji avec Markdown dans un commentaire de pull request :

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

Cette image montre la vue publiée des réactions emoji :

Capture d’écran de la vue publiée des emojis dans un commentaire de pull request.

Exemple : Syntaxe de l’emoji d’échappement dans Markdown

Cet exemple montre comment échapper la syntaxe des emoji avec le caractère de barre oblique inverse \ dans Markdown :

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

Cette image montre la vue publiée de Markdown qui affiche la syntaxe emoji :

Capture d’écran montrant comment échapper la syntaxe d’emoji dans Markdown à l’aide de la barre oblique inverse « \ ».

Dans un commentaire de pull request, utilisez deux backslashes \\ pour échapper à la conversion de syntaxe emoji.

Caractères spéciaux en tant que texte littéral

Utilisez la barre oblique inverse \ comme caractère d’échappement dans Markdown pour publier des caractères spéciaux en tant que texte brut. La barre oblique inverse indique au système de publication d’afficher le caractère spécial en tant que texte littéral et de ne pas l’interpréter ni de le convertir.

Utilisez la syntaxe d'échappement et d'ignorance dans une définition de fait (board), le widget Markdown, les requêtes de tirage, les fichiers README et les fichiers wiki.

Exemple : Publier des caractères spéciaux

La syntaxe Markdown « Placer du texte entre les backticks » s’affiche sous forme de Enclose text in backticks dans la vue publiée. Le système de publication applique le inline code format au texte dans les backticks (') et ne publie pas les backticks.

Si vous préfixez le backtick (`) avec un antislash (\), le format de texte dans les backticks ne change pas et les backticks sont publiés. Ce comportement fonctionne pour la plupart des caractères spéciaux, y compris les ()parenthèses, crochets, trait de soulignement [], trait d’union _, marque de hachage -, astérisque, backtick # et la barre oblique inverse * elle-même.

Le Markdown suivant utilise le caractère antislash \ pour afficher des caractères spéciaux en tant que texte brut :

\\\ Code comment

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

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

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

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

Voici la vue publiée de Markdown :

\\ Commentaire de code

Afficher le __trait de soulignement__

# Commentaire de code et non titre

( Inclure les parenthèses )

Afficher les *astérisques* et ne pas passer aux italiques

Note

Pour certains Markdown, entrez le code HTML &#92; pour l'antislash au lieu du symbole de caractère \.

Attachments

Joignez des fichiers dans les commentaires de pull request et les pages wiki. Les pièces jointes peuvent vous aider à illustrer votre point ou à fournir des détails sur vos suggestions. Les pièces jointes prennent en charge les formats de fichier suivants :

Type de pièce jointe

Formats de fichier

Code

C# (.cs), Extensible Markup Language (.xml), JavaScript Object Notation (.json), Hypertext Markup Language (.html, .htm), Layer (.lyr), Script Windows PowerShell (.ps1), Roshal Archive (.rar), Connexion Bureau à distance (.rdp), Structured Query Language (.sql)

Remarque : Les pièces jointes de code ne sont pas prises en charge dans les commentaires de demande de tirage.

Fichiers compressés

ZIP (.zip), GZIP (.gz)

Documents

Markdown (.md), Message Microsoft Office (.msg), Microsoft Project (.mpp), Word (.doc, .docx), Excel (.xls, .xlsx, .csv), PowerPoint (.ppt, .pptx), Texte brut (.txt), Format de document portable (.pdf)

Images

PNG (.png), GIF (.gif), JPEG (.jpeg, .jpg), Icônes (.ico)

Visio

VSD (.vsd, .vsdx)

Video

MOV (.mov), MP4 (.mp4)

Note

Tous les formats de fichier ne sont pas pris en charge en tant que pièces jointes dans les commentaires de demande de tirage, tels que les fichiers microsoft Office Message (.msg).

Joindre des images ou des fichiers

Vous pouvez joindre une image ou un fichier dans la zone de Commentaire d'une pull request (demande de tirage) ou sur une page wiki dans le volet Modifier de plusieurs façons :

  • Faites glisser un fichier dans le commentaire ou sur la page wiki.

  • Collez une image depuis votre presse-papiers dans le commentaire ou sur la page wiki. L’image s’affiche directement dans le commentaire ou sur la page wiki.

  • Sélectionnez l’icône Attacher (paperclip) dans le commentaire ou dans le volet Format de votre page wiki, puis choisissez le fichier à joindre :

    Capture d’écran montrant comment sélectionner l’icône paperclip pour joindre un fichier à une page wiki.

Lorsque vous joignez un fichier non-image, le système crée un lien vers le fichier dans le commentaire ou sur la page wiki. Modifiez le texte d’affichage du lien entre crochets, comme dans [Updated link display text](LINK URL). Lorsque vous publiez la page ou le commentaire, l’utilisateur sélectionne le lien pour accéder à la pièce jointe.

Notation mathématique et caractères

Vous pouvez utiliser la notation mathématique et les caractères dans les commentaires de demande de tirage et les fichiers wiki. La notation en ligne et la notation KaTeX de bloc sont prises en charge, ce qui inclut les éléments suivants :

  • Symbols
  • Lettres grecques
  • Opérateurs mathématiques
  • Puissances et index
  • Fractions et binomiales
  • Autres éléments pris en charge par KaTeX

Dans un fichier Markdown, la notation mathématique est placée entre les signes dollar $ . Pour créer une expression inline avec le reste du texte, entourez la notation avec des signes dollar simples $ A + B = C $. Pour une expression de bloc, commencez et terminez le bloc avec deux signes de dollar. $$ A = 1 \ B = 2 \ C = A + B $$

Exemple : Répertorier les caractères grecs

L’exemple suivant répertorie les caractères grecs utilisés dans la notation mathématique en ajoutant un extrait de code dans le fichier Markdown. Notez que l’identificateur de langue de l’extrait de code n’est KaTeX pas 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$

Voici la vue publiée des caractères grecs :

Capture d’écran montrant la vue publiée de l’extrait de code KaTex qui répertorie les caractères grecs utilisés dans la notation mathématique.

Exemple : Utiliser la notation algébrique

L’exemple suivant utilise une notation inline et une expression de bloc algébrique :

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

And, the area of a triangle is:

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

Voici la vue publiée de la notation dans le fichier Markdown :

Capture d’écran montrant la vue publiée de l’extrait de code KaTex qui inclut la notation inline et une expression de bloc algébrique.

Exemple : Afficher les sommes et les intégrales

L’exemple suivant utilise deux expressions de bloc pour calculer des sommes et des intégrales :

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

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

Voici la vue publiée des expressions dans le fichier Markdown :

Capture d’écran montrant la vue publiée de l’extrait de code KaTex qui utilise deux expressions de bloc pour calculer les sommes et les intégrales.

Markdown dans un wiki Azure DevOps

Il existe de nombreuses façons d’utiliser Markdown pour améliorer votre wiki Azure DevOps. Les sections suivantes fournissent des exemples de syntaxe pour différentes tâches :

  • Ajouter des diagrammes Mermaid comme des séquences, des organigrammes et des parcours utilisateur
  • Créer une table des matières (TOC) pour les pages et les sous-pages
  • Configurer des sections de page rétractables
  • Incorporer des vidéos et des résultats de requête Azure Boards
  • Lien vers des éléments de travail avec le signe dièse #
  • Utiliser des mentions @<alias> pour les utilisateurs et les groupes
  • Inclure des éléments HTML comme <font> pour le texte enrichi
  • Vérifier le nombre de visites de page

La disponibilité de ces fonctionnalités dépend de votre version d’Azure DevOps.

Utiliser des diagrammes Mermaid

Mermaid vous permet de créer des diagrammes et des visualisations à l’aide de texte et de code. Le wiki Azure DevOps prend en charge les types de diagrammes mermaid suivants :

Pour plus d’informations, consultez les notes de publication de Mermaid.

Limitations

Lorsque vous utilisez le diagramme Mermaid dans Azure DevOps, gardez à l’esprit les limitations suivantes :

  • Azure DevOps fournit une prise en charge de syntaxe limitée pour les types de diagrammes mermaid. La syntaxe non prise en charge inclut la plupart des balises HTML, Font Awesome, la syntaxe flowchart (utiliser l’élément graph à la place), LongArrow ---->, etc.

  • Internet Explorer ne prend pas en charge Mermaid. Si vous utilisez des diagrammes mermaid dans votre wiki, les diagrammes ne s’affichent pas dans Internet Explorer.

Exemple : Ajouter un diagramme mermaid à la page wiki

Pour ajouter un diagramme mermaid à une page wiki, commencez et terminez la notation avec trois points-virgules :. Spécifiez le mermaid mot clé, le type de diagramme, tel que sequenceDiagram, et fournissez les informations à illustrer. Les informations à représenter sous forme de diagramme sont spécifiées dans une section en retrait dans la syntaxe.

L’exemple suivant montre comment ajouter un diagramme mermaid à une page wiki :

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

Exemple : Diagramme de séquence

Un diagramme de séquence (type sequenceDiagram) est une illustration d’interaction qui montre comment les processus fonctionnent les uns avec les autres et dans quel ordre.

L’exemple suivant montre comment ajouter un diagramme de séquence à une page wiki :

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

Voici la vue publiée du diagramme de séquence :

Capture d’écran de Mermaid Live Editor avec le code d’un diagramme de séquence et un aperçu de la vue publiée.

Exemple : Diagramme de Gantt

Un diagramme de Gantt (type gantt) enregistre chaque tâche planifiée sous la forme d’une barre continue qui s’étend de gauche à droite. L'axe x représente le temps. L’axe y enregistre les tâches et leur ordre d’achèvement.

Lorsque vous excluez une date, un jour ou une collection de dates spécifiques à une tâche, le diagramme de Gantt accepte les modifications. Le graphique s’étend d’un nombre égal de jours vers la droite plutôt que de créer un espace vide à l’intérieur de la tâche.

L’exemple suivant montre comment ajouter un diagramme de Gantt à une page wiki :

::: 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
:::

Voici la vue publiée du diagramme de Gantt :

Capture d’écran de Mermaid Live Editor avec le code d’un diagramme de Gantt et un aperçu de la vue publiée.

Exemple : Organigramme

Un organigramme (type graph) est composé de nœuds, de formes géométriques et de bords, et de flèches ou de lignes. Une fois que vous avez identifié le type de graph diagramme, spécifiez la direction du flux pour obtenir des informations dans le graphique, par TB; exemple pour le haut en bas.

L’exemple suivant crée un organigramme avec le type graph. Les informations de graphique suivent une direction de gauche à droite LR; .

Note

Azure DevOps ne prend pas en charge le flowchart type de diagramme, la syntaxe de flèche ----> ou les liens vers et à partir d’un subgraph type de diagramme.

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

Voici l’affichage publié du graphique d’organigramme :

Capture d’écran de Mermaid Live Editor avec le code d’un graphique d’organigramme et un aperçu de la vue publiée.

Exemple : Diagramme de classes

Le diagramme de classes (type classDiagram) est la partie essentielle du modèle de programmation orienté objet. Le diagramme décrit les objets avec leurs attributs et méthodes, ainsi que l’héritage entre les objets.

L’exemple suivant montre comment ajouter un diagramme de classes à une page wiki :

:::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()
    }
:::

Voici la vue publiée du diagramme de classes :

Capture d’écran de Mermaid Live Editor avec le code d’un diagramme de classes et un aperçu de la vue publiée.

Exemple : Diagramme d’état

Le diagramme d’état (type stateDiagram) décrit comment les états système peuvent changer lorsqu’ils passent d’un état à un autre.

L’exemple suivant montre comment ajouter un diagramme d’état à une page wiki. Cet exemple utilise la version 2 du type de diagramme d’état (type stateDiagram-v2).

:::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
    }
:::

Voici la vue publiée du diagramme d’état :

Capture d’écran de Mermaid Live Editor avec le code d’un diagramme d’état et un aperçu de la vue publiée.

Exemple : diagramme de parcours utilisateur

Le diagramme de parcours utilisateur (type journey) décrit les étapes requises pour effectuer une action ou une tâche de niveau supérieur spécifique.

L’exemple suivant montre comment ajouter un diagramme de parcours utilisateur à une page wiki :

:::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
:::

Voici la vue publiée du diagramme de parcours utilisateur :

Capture d’écran montrant un aperçu publié d’un diagramme de parcours utilisateur dans le Mermaid Live Editor.

Exemple : diagramme à secteurs

Le diagramme circulaire (type pie) permet de visualiser les pourcentages d’informations dans un diagramme circulaire. Après avoir identifié le type de diagramme pie, spécifiez le mot clé title avec un titre pour le graphique à secteurs.

L’exemple suivant crée un graphique à secteurs avec le titre Fishermen in countries :

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

Voici la version publiée du graphique circulaire.

Capture d’écran de Mermaid Live Editor avec le code d’un graphique en secteurs et un aperçu de la vue publiée.

Exemple : Diagramme des conditions requises

Le diagramme des exigences (type requirementDiagram) crée une visualisation des exigences et de leurs connexions.

L’exemple suivant montre comment ajouter un diagramme de conditions requises à une page wiki :

:::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
:::

Voici la vue publiée du diagramme des exigences :

Capture d’écran de Mermaid Live Editor avec le code d’un diagramme de conditions requises et un aperçu de la vue publiée.

Exemple : diagramme Gitgraph

Un diagramme de graphique Git (type gitGraph) est utilisé pour visualiser les opérations Git telles que les validations, les branches et les fusions.

L’exemple suivant montre comment ajouter un diagramme de graphique git à une page wiki :

::: 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"
:::

Voici l’affichage publié du diagramme de graphique git :

Capture d’écran de Mermaid Live Editor avec le code d’un diagramme de graphique git et un aperçu de la vue publiée.

Exemple : diagramme de relation d’entité

Un diagramme de relation d’entité (type erDiagram) est utilisé pour modéliser les relations entre les entités d’un système, telles qu’une base de données ou une application. Ces diagrammes permettent de comprendre et de concevoir la structure des données et de ses interconnexions.

L’exemple suivant montre comment ajouter un diagramme de relation d’entité à une page wiki :

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

Voici la vue publiée du diagramme de relation d’entité :

Capture d’écran de Mermaid Live Editor avec le code d’un diagramme de relation d’entité et un aperçu de la vue publiée.

Exemple : Diagramme de chronologie

Un diagramme de chronologie (type timeline) est utilisé pour visualiser les événements dans l’ordre chronologique, ce qui facilite le suivi de la progression ou des événements historiques.

L’exemple suivant montre comment ajouter un diagramme de chronologie à une page wiki :

::: 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
:::

Voici la vue publiée du diagramme de chronologie :

Capture d’écran de Mermaid Live Editor avec le code d’un diagramme de chronologie et un aperçu de la vue publiée.

Table des matières d’une page wiki

Créez une table des matières (TOC) pour votre page wiki à l’aide de la [[_TOC_]] balise de syntaxe. Lorsque le système de publication rencontre la balise et confirme la présence d'au moins un en-tête sur la page wiki, il génère la table des matières pour la page. Le titre de la table des matières sur la page est « Contenu ».

Capture d’écran montrant comment appliquer la balise de syntaxe TOC pour générer un TOC pour une page wiki.

Pour créer le toc, vous pouvez ajouter la [[_TOC_]] balise de syntaxe à la page wiki dans markdown ou sélectionner Plus d’options (...) >Table des matières dans l’affichage Modifier de la page.

Voici quelques points sur l’ajout d’un TOC :

  • La syntaxe de la balise [[_TOC_]] respecte la casse. Si vous spécifiez la syntaxe à l’aide de minuscules [[_toc_]], le TOC risque de ne pas s’afficher.
  • Le système de publication restitue la TOC pour la première instance de la balise [[_TOC_]] dans la page Markdown. Il ignore d’autres instances de la balise sur la même page.
  • Vous pouvez placer la [[_TOC_]] balise n’importe où dans markdown. Le système affiche la table des matières sur la page à l’emplacement où vous avez placé la balise dans Markdown.
  • Le système reconnaît uniquement les titres de style Markdown identifiés par la syntaxe avec le signe dièse #. Il ignore les balises de titre de style HTML.
  • Le système utilise uniquement le texte de titre pour créer l’entrée TOC. Il ignore toutes les syntaxes HTML et Markdown supplémentaires.

L’exemple suivant montre comment le système de publication ignore la mise en forme supplémentaire d’un titre lorsqu’il crée l’entrée pour la table des matières. Le titre met en forme le mot « Phare » avec des italiques, mais l’entrée TOC pour le titre supprime le style supplémentaire.

Capture d’écran montrant comment le système de publication ignore la mise en forme supplémentaire d’un titre lorsqu’il crée l’entrée pour la table des matières.

Tableau des sous-pages d’une page wiki

Ajoutez une table de sous-pages pour une page wiki à l’aide de la [[_TOSP_]] balise de syntaxe. Le titre du tableau de la page est « Pages enfants ». Le tableau inclut une entrée pour chaque sous-page de la page wiki.

Pour créer la table des sous-pages, vous pouvez ajouter la [[_TOSP_]] balise de syntaxe à la page wiki dans markdown ou sélectionner Plus d’options (...) >Tableau des sous-pages dans l’affichage Modifier de la page.

Voici quelques points sur l’ajout d’une table de sous-pages :

  • La syntaxe de la balise [[_TOSP_]] respecte la casse. Si vous spécifiez la syntaxe à l’aide de minuscules [[_tosp_]], la table des sous-pages peut ne pas être affichée.
  • Le système de publication affiche la table des sous-pages pour la première instance de la [[_TOSP_]] balise dans la page Markdown. Il ignore d’autres instances de la balise sur la même page.
  • Vous pouvez placer la [[_TOSP_]] balise n’importe où dans markdown. Le système restitue la table des sous-pages de la page à l’emplacement où vous avez placé la balise dans Markdown.

Capture d’écran montrant comment le système de publication génère une table de sous-pages pour une page wiki.

Sections repliables dans une page wiki

Ajoutez une section réductible dans une page wiki avec la syntaxe HTML <details><summary> . Vous pouvez utiliser une section réductible pour limiter la visibilité du contenu spécifique sur la page, par exemple des données obsolètes ou archivées, ou configurer un scénario de question/réponse.

Lorsque la page wiki s’ouvre, la section repliable est fermée (réduite), mais le résumé de la section reste visible. Les utilisateurs peuvent sélectionner le titre à développer (ouvrir) et réduire la section si nécessaire.

Voici les points à considérer pour l’ajout d’une section repliable :

  • Indiquez le titre de la section dans les <summary>Title</summary> balises. Le résumé est toujours visible sur la page.
  • Ajoutez une ligne vide après la balise de fermeture </summary> . Si vous n’ajoutez pas la ligne vide, la section ne s’affiche pas correctement.
  • Fournissez le contenu principal après la ligne vide. Vous pouvez utiliser la syntaxe Markdown et html pour mettre en forme le contenu principal.
  • Si vous créez plusieurs sections réductibles sur la page, ajoutez une ligne vide après chaque balise fermante </details> .

L’exemple suivant crée une section repliable sur une page wiki :

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

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

Capture d’écran de Mermaid Live Editor avec le code d’une section réductible et un aperçu de la vue publiée.

Vidéos incorporées

Incorporer des vidéos à partir de YouTube et de Microsoft Streams dans une page wiki à l’aide de la ::: video ::: syntaxe. Dans la video déclaration, définissez un <iframe> bloc pour la vidéo. Fournissez un lien vers la vidéo et spécifiez la largeur et la hauteur préférées. Vous pouvez définir d’autres attributs tels que les bordures et le mode plein écran. Les deux-points ::: fermants sont nécessaires pour éviter la rupture de la page.

L’exemple suivant incorpore une vidéo dans la page wiki :

Watch the following video:

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

Voici la vue publiée de la page wiki avec la vidéo incorporée :

Capture d’écran montrant la vue publiée de la page wiki avec la vidéo incorporée.

Résultats des requêtes Azure Boards incorporées

Incorporer des résultats de requête Azure Boards dans une page wiki sous forme de table à l’aide de la query-table syntaxe avec un ID de requête :

Results from the Azure Boards query:

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

Vous pouvez également sélectionner Plus d’options (...) >Résultats de la requête dans la barre d’outils :

Capture d’écran montrant comment sélectionner Résultats de la requête dans le menu Autres options pour incorporer les résultats de la requête sous forme de tableau dans la page wiki.

Dans la boîte de dialogue Résultats de la requête, sélectionnez les résultats de la requête, puis sélectionnez Insérer pour incorporer les résultats sous forme de tableau dans la page wiki.

Pour plus d’informations sur la copie de l’URL de requête, qui fournit un GUID pour la requête, consultez Les éléments de requête e-mail ou l’URL de la requête de partage.

Notifications avec des mentions @

Créez des mentions pour les utilisateurs ou les groupes avec le symbole @ comme dans @<user-alias>. Lorsque vous entrez le symbole ,@ la boîte de dialogue Suggestion automatique s’ouvre, où vous pouvez sélectionner des utilisateurs ou des groupes pour recevoir des notifications par e-mail :

Capture d’écran montrant comment sélectionner un utilisateur dans la boîte de dialogue Suggestion automatique pour ajouter une mention @ dans la page wiki.

Vous pouvez également sélectionner Plus d’options (...) >@ Mention dans la barre d’outils :

Capture d’écran montrant comment sélectionner @ Mention dans le menu Autres options pour ajouter une mention pour un utilisateur ou un groupe dans la page wiki.

Lorsque vous modifiez des pages directement dans le code, utilisez le modèle suivant. @<{identity-guid}>

Nombre de visites de page pour une page wiki

Ajoutez un nombre agrégé automatiquement de visites de pages pour les 30 derniers jours sur chaque page du wiki. Une visite de page est une vue de la page par un utilisateur spécifié pendant un intervalle de 15 minutes.

Utilisez l’API batch pagesBatch pour voir le nombre quotidien de visites sur toutes les pages dans une vue paginée. La vue n’est pas triée selon le nombre de visites.

Pour les données de plus de 30 jours, utilisez l’API REST pour obtenir la liste de toutes les visites de pages. Triez les pages en fonction du nombre de visites et déterminez les 100 premiers. Vous pouvez stocker les visites dans un tableau de bord ou une base de données.

L’image suivante montre le nombre de pages sur une page wiki publiée :

Capture d’écran montrant le nombre agrégé de visites de pages sur une page wiki publiée.

Balises HTML dans les pages wiki

Créez du contenu enrichi à l’aide de balises HTML dans des pages wiki, telles que <font> et <span>. Dans Azure DevOps Server 2019.1 et versions ultérieures, vous pouvez également coller du contenu enrichi comme des images et des vidéos au format HTML.

Exemple : Utiliser la syntaxe Markdown dans HTML

L’exemple suivant montre comment utiliser la syntaxe Markdown à l’intérieur d’un élément HTML dans une page wiki. Ajoutez une ligne vide après l’élément HTML ouvrant et avant 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>

Exemple : Incorporer une vidéo avec HTML

L’exemple suivant montre comment incorporer une vidéo dans une page wiki à l’aide de l’élément <video> HTML avec une URL vers la vidéo :

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

Exemple : Utiliser le format de texte enrichi

L’exemple suivant montre comment utiliser le format de texte enrichi HTML dans une page 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>

L’image suivante montre l’affichage publié du contenu de texte enrichi HTML dans une page wiki, comme indiqué dans l’affichage de thème Clair standard :

Capture d’écran d’une page wiki publiée qui utilise la mise en forme de texte enrichi HTML, comme illustré en mode Thème Clair.

Voici la même page publiée en mode thème sombre :

Capture d’écran d’une page wiki publiée qui utilise la mise en forme de texte enrichi HTML, comme illustré en mode Thème sombre.