On peut trouver en-ligne la spécification originale du Markdown. Le Markdown peut être utilisé dans les commentaires de mon site, mais aussi à bien d’autres fin : voir les remarques en fin d’article à ce sujet.
Je regroupe ici les principales syntaxes utiles.
Table des syntaxes abordées :
| Titres | Paragraphes | Sauts de lignes | Traits horizontaux |
| Gras/Italique | Code en-ligne | Bloc de code | Citations |
| Listes à puces | Listes numérotées | Tableaux | Liens |
| Images | Lien vers une image | Divers | Remarque |
Titres
# Titre 1
## Titre 2
### Titre 3
#### etc...
Syntaxe alternative pour les **Titres 1** et les **Titres 2**
Titre 1
=======
Titre 2
-------
donne
Titre 1
Titre 2
Titre 3
etc…
Syntaxe alternative pour les Titres 1 et les Titres 2
Titre 1
Titre 2
Paragraphes
Pour changer de paragraphe
on saute une ligne.
donne
Pour changer de paragraphe
on saute une ligne.
Sauts de lignes
Pour passer à la ligne au sein d'un même paragraphe, on met deux espaces en fin de ligne (ici ->)
puis on passe à la ligne.
donne
Pour passer à la ligne au sein d’un même paragraphe, on met deux espaces en fin de ligne (ici ->)
puis on passe à la ligne.
Traits horizontaux
Pour faire un trait horizontal, on place 3 signes - ou * ou _ dans un paragraphe indépendant
---
***
___
donne
Pour faire un trait horizontal, on place 3 signes - ou * ou _ dans un paragraphe indépendant
Emphases
L'*italique* s'obtient en _entourant un texte_ avec une * ou un _
Le **gras** s'obtient de __la même façon__ mais avec **_des délimiteurs doublés._**
On peut ~~barrer~~ un texte en utilisant des tildes.
On peut ~~**_tout mixer !_**~~
donne
L’italique s’obtient en entourant un texte avec une * ou un _
Le gras s’obtient de la même façon mais avec des délimiteurs doublés.
On peut barrer un texte en utilisant des tildes.
On peut tout mixer !
Code en-ligne
On peut mettre en valeur un bout de `print("code")` en-ligne en utilisant le caractère `.
donne
On peut mettre en valeur un bout de print("code") en-ligne en utilisant le caractère `.
Bloc de code
```
s = "Code sans mise en valeur syntaxique"
print(s)
```
```python
s = "Code avec mise en valeur syntaxique"
print(s)
```
donne
s = "Code sans mise en valeur syntaxique"
print(s)
s = "Code avec mise en valeur syntaxique"
print(s)
Citations
> Les savants des temps passés et des nations révolues n'ont cessé de composer des livres. Ils l'ont fait pour léguer leur savoir à ceux qui les suivent. Ainsi demeurera vive la quête de la vérité.
> *Al-Khwarizmi*
donne
Les savants des temps passés et des nations révolues n’ont cessé de composer des livres. Ils l’ont fait pour léguer leur savoir à ceux qui les suivent. Ainsi demeurera vive la quête de la vérité.
Al-Khwarizmi
Listes à puces
- Item
- Deuxième item
- Sous-liste : **_3_** espaces en début de ligne
- Deuxième item de la sous-liste
- Dernier item
donne
- Item
- Deuxième item
- Sous-liste : 3 espaces en début de ligne
- Deuxième item de la sous-liste
- Dernier item
Listes numérotées
1. Item
1. Deuxième item
1. Sous-liste : **_3_** espaces en début de ligne
1. Deuxième item de la sous-liste
* Liste à puces dans une liste numérotée : **_3_** espaces supplémentaires en début de ligne
* etc...
Un paragraphe indépendant dans la même liste à puces : **_2_** espaces supplémentaires en début de ligne.
1. **Remarque** : pas de possibilité de numérotation alphanumérique en Markdown standard.
donne
- Item
- Deuxième item
- Sous-liste : 3 espaces en début de ligne
- Deuxième item de la sous-liste
- Liste à puces dans une liste numérotée : 3 espaces supplémentaires en début de ligne
-
etc…
Un paragraphe indépendant dans la même liste à puces : 2 espaces supplémentaires en début de ligne.
- Remarque : pas de possibilité de numérotation alphanumérique en Markdown standard.
Tableaux
| Avec titres de colonne | Deuxième colonne |
| :--------------------- | :--------------- |
| Un | Deux |
| Trois | Quatre |
------
| :----- | :----- |
| Sans titres de colonne | Deuxième colonne |
| 1 | 2 |
| 3 | 4 |
donne
| Avec titres de colonne | Deuxième colonne |
|---|---|
| Un | Deux |
| Trois | Quatre |
| Sans titres de colonne | Deuxième colonne |
| 1 | 2 |
| 3 | 4 |
Liens
L'[une des pages](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) dont je me suis inspiré.
donne
L’une des pages dont je me suis inspiré.
Images
Un logo Markdown : .
donne
Un logo Markdown : 
.
Lien vers une image
Spécification originale du Markdown : ici ---> [](https://daringfireball.net/projects/markdown/)
donne
Spécification originale du Markdown : ici —>
Divers
Texte<sup>en exposant</sup> et texte<sub>en indice</sub>.
donne
Texteen exposant et texteen indice.
Texte <ins>souligné</ins>.
donne
Texte souligné.
On peut faire des trucs encore plus drôle ! Par exemple, on peut généralement utiliser le langage HTML dans un parseur Markdown.
1
2
3
4
5
6
7
8
9
10
11
12
13
def fact(n):
p = 1
for k in range(n):
p *= (k+1)
return p
def dfact(n,p):
if p <= 0:
return n
return fact(dfact(n,p-1))
def superfact(n):
return dfact(n,n)
print(superfact(3)) # a number with 1747 digits
# Don't try superfact(4) !
Ou encore : lien vers une de mes vidéos Youtube :
Remarque
Le Markdown n’est pas spécifique à Github. On peut l’utiliser par exemple dans les fichier Jupyter Notebook.