Premier article de ce blog !

Un guide du langage Markdown. Ce langage même qui me sert a rédiger ce post !


Qu’est-ce que le Markdown ?

Il s’agit d’un langage créé en 2004 ayant (enfin) pour but de lire et d’écrire des documents balisés en s’affranchissant de la lourdeur du langage HTML ou BBCODE. On le retrouve un peu partout désormais, par exemple sur Github, Discord, etc…
Les extensions de fichier sont '.md' et '.markdown'.
En outre, il est question d’utiliser des combinaisons de caractères pour transformer le texte. Comme *italique* et **gras** pour écrire : “Le gras c’est la vie…” par exemple.
J’imagine que vous avez compris un peu l’idée. Passons aux détails et tout deviendra plus clair !

Vous pouvez utiliser le caractère underscore (_) ou étoile * indifféremment. C’est surtout une question de clarté du texte brut. Personnellement j’ai le reflexe d’utiliser * car je me sers souvent de _ dans mes notes.
C’est parti !


L’accentuation

Italique = *Italique*
Gras = **Gras**
Italique & Gras = ***Italique & Gras*** ou _**Italique & Gras**_ peu importe.
Barré = ~~Barré~~


Les paragraphes

P1

P2

P3

P4

P5
P6
# P1 (souligné)
## P2
### P3
#### P4
##### P5
###### P6

La séparation entre deux paragraphes ou blocs de texte se fait en laissant une ligne vide entre eux.
Pour retourner à la ligne il ne suffit pas de faire ‘entrée’, il faut aussi laisser deux espaces à la fin de la ligne précédente !


Ecrire du code

Markdown offre la possibilité d’écrire du code de manière à ce qu’il soit clairement identifié et non interprété. Il suffit pour cela de le placer entre des accents graves ` généralement AltGr+7 sur votre clavier.

Code = `Code`

Avec 3 ` succincts vous pouvez créer des blocs de code et même préciser de quel langage il s’agit pour la colorisation ! Pour indiquer le langage utilisé il suffit de l’écrire après les 3 premiers ` du bloc.
Pour incorporer les ``` dans d’autres (en mode poupées russes) il faut ajouter un ` à chaque itération.

Ainsi, ce bout de code en C :

#include <unistd.h>
int pipe(int pipefd[2]); 

s’écrit :

```c
#include <unistd.h>
int pipe(int pipefd[2]); 
```

Cela fonctionne aussi avec bash, go, js, etc…


Les listes

Il faut sauter une ligne avant la liste. Puis utiliser * ou + ou - et l’indentation.

  • 1ère ligne
  • 2ème ligne
    • 1ère ligne sous la 2ème
      • etc… etc…
* 1ère ligne
* 2ème ligne
	* 1ère ligne sous la 2ème
		* etc... etc...

Même concept pour les listes numérotées :

  1. 1ère ligne
  2. 2ème ligne
    1. 1ère ligne sous la 2ème
      1. etc… etc…
1. 1ère ligne
2. 2ème ligne
	1. 1ère ligne sous la 2ème
		1. etc... etc...

Et pour les ‘checklists’ :

  • Élément de liste coché
  • Élément de liste
- [x] Élément de liste coché
- [ ] Élément de liste

Ça suit toujours ?! Alors on attaque les trucs chiants…


Les tableaux

Bon… un tableau c’est des pipes |, des tirets -, et des deux-points :. Peu importe les espaces et le fait que le tableau ressemble vraiment à un tableau dans le code brut.

Colonne 1 Colonne 2 Colonne 3 Colonne 4
Ligne 1 Ligne 1 Ligne 1 Ligne 1
Alignée à gauche Centré Alignée à droite Sans alignement
| Colonne 1        |     Colonne 2     |        Colonne 3 |        Colonne 4 |
| :--------------- | :---------------: | ---------------: | ---------------- |
| Ligne 1          |       Ligne 1     |          Ligne 1 | Ligne 1          |
| Alignée à gauche |       Centré      | Alignée à droite | Sans alignement  |

Mais ça marche aussi comme ça :

|Colonne 1|Colonne 2|Colonne 3|Colonne 4
|:-|:-:|-:|-
|Ligne 1|Ligne 1|Ligne 1|Ligne 1
|Alignée à gauche|Centré|Alignée à droite|Sans alignement

Les hyperliens et les images

Pour créer un lien :

Exemple de lien

[Exemple de lien](URL_de_mon_lien "Texte à afficher au passage de souris")

Le texte à afficher par la souris est optionnel.

Pour incorporer une image :

Logo Markdown

![Texte en cas de problème d'affichage](url_de_mon_image "Texte à afficher au passage de souris")

Le lien peut aussi bien être une URL qu’un chemin local du systeme de fichiers (absolu ou relatif).
Tout comme l’image, le texte à afficher par la souris est optionnel.


Divers

  • Il est possible d’incorporer du HTML dans le Markdown.

  • Vous pouvez faire des citations avec >.

“Le gras c’est la vie…”
– Karadoc, Livre II - Corpore sano

> *“Le **gras** c’est la vie…”*  
> -- Karadoc,  Livre II - Corpore sano
  • Vous pouvez utiliser des séparateurs comme je l’ai fait tout au long de cette article avec ***, ---, ___
  • Il n’est, à priori, pas possible de souligner autrement qu’en utilisant HTML :(
<u>souligner</u>

J’espère que cet article vous a plu, n’hésitez pas à le partager sur vos réseaux ! =)