Markdown
 |
Cet article est une ébauche concernant l’informatique.
Vous pouvez partager vos connaissances en l’améliorant (comment ?) selon les recommandations des projets correspondants.
|
Markdown est un langage de balisage léger créé par John Gruber et Aaron Swartz.
Le but de la syntaxe Markdown est d'offrir une syntaxe facile à lire et à écrire. C'est-à-dire qu'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. Bien que la syntaxe Markdown ait été influencée par plusieurs filtres de conversion de texte vers HTML existants — incluant Setext[1], atx[2], Textile, reStructuredText, Grutatext[3] et EtText[4] — la source d’inspiration principale de la syntaxe Markdown est le format du courrier électronique en mode texte.
Sommaire |
Quelques exemples [modifier]
Voici quelques exemple de syntaxe Markdown. Quelques balises HTML équivalentes sont données.
Cette liste n'est pas exhaustive.
Formatage [modifier]
Pour mettre du texte en italique (balise HTML <i>) :
*quelques mots* ou _quelques mots_
Pour mettre du texte en gras (balise HTML <b>) :
**plus important** ou __également important__
Pour mettre du code dans le texte (balise HTML <code>) :
Mon texte `code` fin de mon texte
Pour un paragraphe de code, mettre quatre espaces devant:
Première ligne de code
Deuxième ligne
Comme dans les courriels, il est possible de faire des citations :
> Ce texte apparaîtra dans un élément HTML <blockquote>.
Pour faire un nouveau paragraphe, sauter une ligne
Premier paragraphe Deuxième paragraphe
Pour faire un simple retour à la ligne, mettre deux espaces en fin de ligne (balise HTML <br>).
Listes [modifier]
Sauter une ligne avant le début de la liste.
Pour créer une liste non ordonnée (balise HTML <ul>) :
* Pommes
* Poires
* Sous élément avec au moins quatre espaces devant.
Et une liste ordonnée (balise HTML <ol>) :
1. mon premier 2. mon deuxième
Titres [modifier]
Les titres sont créés avec un certain nombre de # avant le titre, qui correspondent au niveau de titre souhaité (le HTML propose 6 niveaux de titres de <h1> à <h6>)
# un titre de premier niveau #### un titre de quatrième niveau
Pour les deux premiers niveaux de titre (<h1> et <h2>), il est également possible de souligner le titre avec des = ou des - (leur nombre réel importe peu).
Titre de niveau 1 =====================
Titre de niveau 2 --------------------
Liens [modifier]
Pour créer des liens (balise HTML <a>) :
[texte du lien](url_du_lien "texte pour le titre, facultatif")
Images [modifier]
Pour afficher une image (balise HTML <img>) :
Mises en œuvre [modifier]
Plusieurs mises en œuvre existent et ce dans différents langages de programmation : en Perl[5], qui reste la mise en œuvre de référence, en PHP[6], en Ruby[7], en Python[8], en Java[9], en C#[10], en Haskell[11], et même en Javascript[12], notamment avec strapdown.js[13].
Notes et références [modifier]
- Setext
- atx
- Grutatext
- EtText
- Perl (implémentation de référence)
- PHP Markdown (Markdown en PHP)
- BlueCloth (Markdown en Ruby)
- Markdown en Python
- markdownj (Markdown en Java)
- Markdown.NET (Markdown en C# et .NET)
- pandoc (Markdown en Haskell)
- showdown (Markdown en Javascript)
- strapdown.js
