outils:markdown

Table des matières

Outils - Mémento de Markdown

Outils - Mémento de Markdown

[Mise à jour le 17/11/2022]

Source
- Markdown Guide : Basic Syntax

Philosophie

Markdown a été conçu pour être aussi facile à lire et à écrire que possible.
La lisibilité, cependant, prime devant tout le reste. Un document formaté selon Markdown devrait pouvoir être publié comme tel, en texte, sans donner l’impression qu’il a été marqué par des balises ou des instructions de formatage.Source

1. Paragraphes

Écrire simplement le texte pour créer un paragraphe. Séparer les paragraphes par une ligne vide.

Exemple

*.md

Ceci est un paragraphe de texte.
 
Ceci est un autre paragraphe de texte !

Résultat
Ceci est un paragraphe de texte.

Ceci est un autre paragraphe de texte !

2. Emphase (gras, italique, barré…)

Emphase faible (italique)

Entourer le texte d'une simple étoile (*) pour l'afficher en italique et d'une double (* *) pour l'afficher en gras.

Exemple

*.md

Voici un mot *important* à mon sens

Résultat : Voici un mot important à mon sens

Emphase forte (gras)

Exemple

*.md

Voici des mots **très importants**, j'insiste !

Résultat : Voici des mots très importants, j'insiste !

Texte barré

Exemple

*.md

Ce texte est ~~barré~~

Résultat : Ce texte est ~~barré~~

3. Les titres

Les titres sont affichés avec le caractère #.

Exemple

*.md

# Titre de niveau 1
 
## Titre de niveau 2
 
### Titre de niveau 3
 
#### Titre de niveau 4

Résultat

Titre de niveau 3

4. Les listes

Les listes à puces

Les listes non ordonnées utilisent l’astérisque *, le plus +, ou encore le tiret — de façon tout à fait interchangeable.

*.md

* Une puce
* Une autre puce
* Et encore une autre puce !

Résultat

Une puce
Une autre puce
Et encore une autre puce !

Les listes à puces numérotées

Les listes ordonnées utilisent un nombre suivi d’un point.

*.md

1. Et de un
2. Et de deux
3. Et de trois

Résultat

Et de un
Et de deux
Et de trois

5. Bloc de citations

On utilise le caractère > pour les blocs de citation.

*.md

> Ceci est un texte cité. Vous pouvez répondre
> à cette citation en écrivant un paragraphe
> normal juste en-dessous !

Résultat

Ceci est un texte cité. Vous pouvez répondre
à cette citation en écrivant un paragraphe
normal juste en dessous !

6. Code source

Bloc de code

Pour produire un bloc de code avec Markdown, vous n’avez qu’à indenter chaque ligne par au moins 4 espaces ou une tabulation (touche Tab).

Exemple et résultat

*.md

Voici un code en C :
 
    int main()
    {
        printf("Hello world!\n");
        return 0;
    }

Resultat

Code en ligne

On insère du code dans une ligne de texte en l'entourant du caractère apostrophe '.

Exemple

*.md

La fonction 'printf()' permet d'afficher du texte

Résultat

Pour tout autre formatage du code (mise en gras ou en couleur des mots-clés, etc.) il faut utiliser les balises HTML (code et pre) pour formater le code et des règles CSS intégrées dans des balises <span style=““>.

Exemple

*.md

<span style=style="color:blue;">Un texte en bleu.</span>

Un texte en bleu.

7. Les liens

Markdown supporte deux styles de liens : incorporé au texte et par référence. Dans les deux cas, le texte du lien est délimité par des [crochets].

Exemple

*.md

Ceci est [un exemple](http://exemple.com/ "Titre") de lien incorporé.
 
[Ce lien](http://exemple.net/) n'a pas de titre.

8. Les images

Markdown utilise une syntaxe d’image qui ressemble à la syntaxe des liens, permettant deux variantes : incorporée et par référence.

Exemple

*.md

![Texte alternatif](/chemin/vers/img.jpg)
 
![Texte alternatif](/chemin/vers/img.jpg "Titre optionnel")

9. Barre de séparation

Vous pouvez produire une ligne horizontale en plaçant au moins trois tirets, astérisques, ou barres de soulignement seuls sur une ligne.

Exemple

*.md

### Ce titre de niveau 3 est séparé du texte
-----------------
Le texte suivant le titre

Résultat

Pour en savoir plus ...

PHP Markdown Syntaxe lien