Markdown
Dialectes / Saveurs

Remarques

Désactivation de la pile

C'est la saveur du démarquage utilisé par Stack Overflow et d'autres sites Stack Exchange. Lorsque vous répondez à une question ou ajoutez de la documentation, vous utilisez cette balise. Cette réponse est faite de démarque SO

Voir la documentation officielle

Les principales choses que SO markdown ajoute sont sous "Ajouts Stack Exchange" sur cette page Web. En particulier, SO ajoute des balises comme [tag:tag] et des liens de raccourci comme [meta] (pas dans les documents), spoilers :

Ceci est un spoiler

>! This is a spoiler

et dévotions linguistiques personnalisées

<!-- language: java -->
```
This text is formatted as if it were Java code
```

This text is formatted as if it were Java code

Doxygen Markdown

Doxygen est un outil de documentation de code couramment utilisé (pour les langages tels que C ++, C # et Java), qui prend également en charge l'utilisation de Markdown. En plus de la syntaxe Markdown standard, il existe un certain nombre d' éléments spécifiques à Doxygen .

Les fonctions principales sont l’utilisation des balises @ref pour les références et les éléments @page , @section/@subsection @anchor et @anchor auxquels ils peuvent faire référence.

@ref <nom> ["texte"]

Cet élément crée un lien (c.-à-d. Une référence) vers une section, une sous-section, une page ou une ancre nommée qui a été définie ailleurs dans la documentation. (voir référence Doxygen )

Le premier paramètre ( name ) doit correspondre au nom de la section, de la sous-section, de la page ou de l'ancre auquel vous souhaitez créer un lien.

Le deuxième paramètre facultatif ( "text" ) doit être encapsulé entre guillemets et définir ce que le lien de référence apparaîtra sur la page. S'il n'est pas utilisé, le lien apparaîtra comme titre utilisé dans la référence.

@section <nom-section> (titre de la section)

Cet élément définit un nom de section. Il est visuellement équivalent à un élément # dans Markdown, mais il définira également une référence qui peut être liée à partir d'autres sections de votre documentation. (voir référence Doxygen )

Le premier paramètre section-name définit le nom de référence pouvant être utilisé par l'élément @ref . Cela ne peut contenir aucun espace.

Le section title deuxième paramètre est une chaîne de mots (qui peut être séparée par des espaces) qui définit le titre de la section qui apparaîtra sur votre page.

Exemple

@section Intro Introduction

This is some text in my introduction.

@section Body Body Paragraph

This is some text in my body, where I refer to the @ref Intro.

Sortie

introduction

Ceci est un texte dans mon introduction.

Paragraphe du corps

C'est un texte dans mon corps, où je fais référence à l'introduction.

NB: Le mot Introduction ci-dessus apparaîtra comme un lien qui passera directement au titre Introduction.

GitHub Flavored Markdown

GitHub Flavored Markdown (parfois abrégé en GFM) facilite le travail avec les balises sur GitHub.com .

Les principales caractéristiques de GFM incluent:

• indentation de code
• support de liste de tâches
• référencement facile des problèmes GitHub
• Détection automatique du nom d'utilisateur et du SHA de GitHub
• détection automatique d'url
• support emoji

Exemples GFM

Mise en évidence de la syntaxe

Avec Markdown, un bloc de code peut être généré avec trois backticks:

```

Sans coloration syntaxique, le code écrit en C apparaît comme ceci

#include <stdio.h>

int main(void)
{
    printf("Hello World\n");
    return (0);
}

Cependant, avec la coloration syntaxique, le code écrit en C apparaît comme ceci:

Pour mettre en évidence le code, ajoutez simplement un identificateur de langue facultatif pour activer la mise en évidence de la syntaxe dans votre bloc de code isolé.

```C
<code text here>
```

Ces améliorations visent à améliorer la qualité de la documentation et des conversations incluses dans les fichiers README , les listes de diffusion , les requêtes d'extraction et les problèmes sur la plate-forme.