Utilisez Markdown

Par gnomnain, dernière mise à jour le 23/12/2009 à 14:37:54

Ce site utilise du markdown pour présenter les posts. Cet article va vous apprendre (un peu) à écrire du markdown correct et à profiter des options de présentation qui vont avec.

Creative Commons BY-SA
Cet article est place sous licence Creative Commons BY-SA

Présentation de base

- Source

D'abord, un premier conseil : utilisez toujours la fonction d'aperçu quand vous postez quelque chose : quelque fois, vous pouvez sans le faire exprès, en utilisant des caractères comme * et _, ajouter du markdown dans votre message. En plus, l'édition des messages n'est pas encore supportée.

Paragraphes et saut de lignes

Un paragraphe est simplement une suite de lignes de texte sépraées des autres par une ligne vide. À l'intérieur d'un paragraphe, les retours à la ligne ne sont pas automatiquement convertis en retours à la ligne HTML : pour insérer un vrai retour à la ligne, il faut terminer une ligne par au moins deux espaces
puis passer à la ligne.

Par exemple, voici le code de ce paragraphe. Les espaces en fin de ligne ont été remplacés par des caractères _ pour être plus visibles :

Un paragraphe est simplement une suite de lignes de texte sépraées des autres par une ligne vide.
À l'intérieur d'un paragraphe, les retours à la ligne ne sont pas automatiquement convertis en_
retours à la ligne HTML : pour insérer un vrai retour à la ligne, il faut terminer une ligne_
par au moins deux espaces_ _
puis passer à la ligne.

Liens hypertextes

Pour créer un lien hypertexte, il suffit de mettre le texte du lien entre crochets [] et l'adresse du lien juste après entre parenthèses. Vous pouvez aussi indiquer un nom pour votre lien :

[Exemple](http://example.com)
[Exemple](http://example.com "Un super site que vous devriez visiter")

donne :

Exemple Exemple

Vous pouvez aussi utiliser une adresse absolue sans le nom de domaine si vous faites un lien vers ce site. Cela permet aux liens de continuer à marcher en cas de déplacement du site (ce qui risque d'arriver un jour).

[Tutoriels](/articles/)

Il y a aussi un raccourci pour insérer des liens : <http://example.com> donne http://example.com.

Gras et italique, code en ligne

Pour mettre un texte en italique, entourez le par des * ou des _ : par exemple *italique* et _italique_ donnent italique. Vous pouvez aussi mettre un texte en gras en mettant ** ou __ : par exemple, **gras** donne gras.

Cela signifie aussi que les * et _ qui se baladent dans votre message risquent de mettre tout votre texte en italique, ce qui n'est sûrement pas ce que vous voulez. Dans ce cas, échappez-les avec \ : par exemple Utilisez \* pour mettre en gras. Vous devrez aussi échapper les \.

Si vous voulez écrire du code, un nom de variable, ou une commande au milieu d'une phrase, encadrez-là entre `. Par exemple `cat /proc/cpuinfo` donne cat /proc/cpuinfo. Si des ` apparaissent dans votre code, entrourez-le par plus de `. Les * et _ qui se trouvent dans des morceaux de code n'influencent pas sur la présentation.

Syntaxe avancée

- Source

Titres

Pour insérer un titre, faites le précéder d'un certain nombre de #. Moins vous en mettez, plus le titre sera gros.

# Titre 1
## Titre 2
### Titre 3
#### Titre 4
##### Titre 5
###### Titre 6

donne :

Titre 1

Titre 2

Titre 3

Titre 4

Titre 5
Titre 6

Images

Vous pouvez insérer une image de la façon suivante (notez bien le point d'exclamation) :

![Texte alternatif](adresse de l'image)

Code

Pour insérer un bloc de code, insérez 4 espaces avant chaque ligne.

Ceci est un bloc de code d'exemple
HAHAHA

Si vous voulez profiter de la coloration syntaxique, la première ligne du bloc de code (elle aussi précéder de 4 espaces) doit être de la forme :::nomdulangage. Par exemple, ceci est un bloc de code coloré :

couleur = True

Citations

Pour faire une citation, précédez chaque ligne que vous citez par >. Vous pouvez aussi utiliser du markdown dans le texte cité. Si vous êtes paresseux, vous pouvez mettre le > seulement pour la première ligne de chaque paragraphe.

Listes

Il y a deux types de listes : les listes non numérotées et les listes numérotées. Pour créer une liste ordonnée, débutez simplement chaque ligne par un *, + ou - :

+ Truc 1
+ Truc 2
+ Truc 3
  • Truc 1
  • Truc 2
  • Truc 3

Vous pouvez créer une liste ordonnée en commençant chaque ligne par un numéro, suivi d'un . :

1. abc
3. def
2. ghi

donne :

  1. abc
  2. def
  3. ghi

Comme vous le voyez, les numéros n'ont pas d'importance. Cependant, la liste doit être séparée des paragraphes précédents et suivant par au moins une ligne vide. Vous pouvez aussi insérer du code dans un élément d'une liste, à condition de précéder le bloc d'au moins 8 espaces.

Attention, les listes sont des blocs, et doivent être séparées par une ligne vide du bloc précédent.