Markdown, la simplicité

Markdown, la simplicité

Le langage Markdown a été créé, il y a 10 ans aujourd’hui. C’est un langage de balisage très simple dont l’objectif est d’être facile à lire et à écrire. Un document formaté en Markdown peut être directement exploité en texte pur.

Au début, le courrier électronique était composé d’un objet ou sujet et du corps du message qui était composé de texte brut (et à côté embarqué une pièce jointe). L’idée de John Gruber et Aaron Swartz était de formaté ce texte brute afin de faire ressortir la structure du message.

Aujourd’hui, un texte formaté en markdown peut être converti en HTML, LaTeX, RTF, etc. Son atout est qu’il est simple et qu’il est possible d’écrire un document en markdown sans logiciel juste de quoi taper du texte.

À LA MANUFACTURE numérique, nous avons fait le choix de l’utiliser pour notre site web et pour éditer notre catalogue de formation. Ce dernier est publié à la fois en HTML et au format PDF après avoir été transformé en LaTeX.

Maintenant que les présentations sont faites, nous allons étudier sa syntaxe.

un peu de gras et d’emphase

Les premières choses que l’on essaye quand on découvre un traitement de texte : mettre des mots en gras et d’autres en italique.

Ce qui se fait en markdown, de la façon suivante : … mots en **gras** … d’autres en _italique_.

barré

Pour barrer un mot ou une phrase, il suffit de l’encadrer par 2 tildes "~~", ~~phrase barrée~~ donne ~~phrase barrée~~.

les citations

le symbole supérieur > permet d’indiquer que l’on faut une citation (comme dans le courrier électronique quand on cite un message précédent.

    `> le symbole….`

Liens et adresses email

Un lien vers une adresse email s’écrit comme ceci:

    `<mon@adresse.email>`

Il est possible de faire la même chose avec un URL :

    `<http://lamanufacturenumerique.fr>`

Toutefois, on peut aussi écrire sous cette forme : [LA MANUFACTURE numérique](http://lamanufacturenumerique.fr) qui a l’avantage de permettre d’appliquer le lien à un texte.

De la même façon, il est possible de faire des références [LA MANUFACTURE numériqe](id_ref_lamanum) à un lien défini dans un autre endroit du document : [id_ref_lamanum]: http://lamanufacturenumerique.fr "Organisme de formation en Système d'Information"

Dans l’exemple précédent, un titre a été ajouté au lien (celui qui apparaît lorsque l’on survole le lien avec le curseur de la souris.

Les images

Pour insérer une image, on ajoute la référence ou l’URL où elle se trouve : ![le logo de LaMaNum]([http://lamanufacturenumerique.fr/img/logo_petit_inv.png)

Après comme pour les liens, il est possible de faire appel à une référence définie ailleurs, ceci est particulièrement pratique si on utilise plusieurs fois la même image.

    `![LaMaNum][img_1]`

et [img_2]: lamanufacturenumerique.fr/img/logo_petit_inv.png

Le brut

L’ensemble de ce billet est écrit en markdown et pour afficher les exemples de code, j’ai encadré les exemples par l’apostrophe inversée `

Par exemple :

        `**gras** `

Autre possibilité, commencer les lignes par une tabulation.

Les listes ordonnées

Les listes ordonnées se formatent en commençant par « 1. » suivi d’un espace :

1. Un
2. Deux
3. Trois

donne

  1. Un
  2. Deux
  3. Trois

Les listes de « bulles »

En début de ligne, il suffit de mettre "*" suivi d’un espace:

* une chose,
* un truc,
* un machin.

donne :

  • une chose,
  • un truc,
  • un machin.

On peut à la place du "*" utiliser le caractère "-" 

Ligne de séparation horizontale

3 "*" ou 3 "-" permettent d’afficher une ligne horizontale.

*** ou ---

Les titres (entrons dans la structure du document)

Le caractère dièse "#" en début de ligne signale un titre et plus il y a de dièses, plus le niveau de titre augmente :

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

Les notes de bas de page

Les notes de bas de page fonctionnent comme les références vu plus haut. Elle sont composées d’un marqueur [marque1] et d’une définition de la note : [marque1]: ceci est la note de bas de page d'exemple

Bloc brut (pour des exemples ou du code)

Commencer une ligne avec 3 ou plus apostrophes inversées et à la fin du bloc finir avec le même nombre d’apostrophes inversées.

```
ça débloque complètement dans ce bloc de code bloqué.
```

Les tableaux

A simple table looks like this:

Voici comment formater un tableau simple :

En-tête 1 | En-tête 2 | En-tête 3
------------ | ------------- | ------------
Cellule 11 | Cellule 21  | Cellule 31
Cellule 12 | Cellule 22  | Cellule 32

on obtient :

En-tête 1 En-tête 2 En-tête 3
Cellule 11 Cellule 21 Cellule 31
Cellule 12 Cellule 22 Cellule 32

Il est possible d’aligner à gauche, au centre et à droite les colonnes en ajoutant : dans la ligne de séparation entre les en-têtes et les cellules :

En-tête 1 | En-tête 2 | En-tête 3
:----- | :-----: | -----:
Cellule 11 | Cellule 21  | Cellule 31
Cellule 12 | Cellule 22  | Cellule 32
En-tête 1 En-tête 2 En-tête 3
Cellule 11 Cellule 21 Cellule 31
Cellule 12 Cellule 22 Cellule 32

Et voilà, le tour d’horizon rapide du langage Markdown. Simple. Non ?