Résumé de la syntaxe Markdown GitHub
Qu’est-ce que Markdown ? Guide concis des principales syntaxes selon GitHub Flavored Markdown (GFM) pour écrire et publier un blog avec GitHub Pages.
Pour utiliser GitHub Pages, il est nécessaire de connaître la syntaxe Markdown. Ce billet s’appuie sur la documentation officielle de GitHub, notamment Maîtriser Markdown et Syntaxe d’écriture et de mise en forme de base.
1. Qu’est-ce que Markdown ?
Markdown est un langage de balisage léger basé sur du texte brut. Il sert à rédiger des documents mis en forme à partir de texte simple et se caractérise par une syntaxe plus facile et plus concise que celle des langages de balisage classiques. Il se convertit aisément en documents formatés comme HTML ou RTF, et est donc largement utilisé pour les fichiers README distribués avec les logiciels ou pour les publications en ligne.
John Gruber a créé le langage Markdown en 12004 de l’ère holocène, en collaboration étroite sur la syntaxe avec Aaron Swartz, avec pour objectif de permettre d’écrire dans un format texte lisible et facile à saisir tout en offrant une conversion optionnelle vers du XHTML (ou HTML) structurellement valide.
2. Syntaxe Markdown
Markdown n’étant pas standardisé, les détails de la syntaxe peuvent varier selon l’environnement. La présente synthèse suit la référence GitHub Flavored Markdown.
2.1. Saut de ligne, séparation de paragraphes
Dans Markdown, appuyer une seule fois sur Entrée n’est pas interprété comme un saut de ligne.
1
2
3
첫째 문장.
둘째 문장.
셋째 문장.
첫째 문장. 둘째 문장. 셋째 문장.
Un saut de ligne s’obtient en ajoutant au moins deux espaces consécutifs en fin de ligne.
1
2
3
첫째 문장.
둘째 문장.
셋째 문장.
첫째 문장.
둘째 문장.
셋째 문장.
On sépare les paragraphes par une ligne vide (deux fois Entrée).
1
2
3
하나의 문단.
다른 문단.
하나의 문단.
다른 문단.
2.2. Titres (headers)
Il existe 6 niveaux.
1
2
3
4
5
6
# This is an H1
## This is an H2
### This is an H3
#### This is an H4
##### This is an H5
###### This is an H6
Le niveau H1 ne devrait en principe apparaître qu’une seule fois par page ; on l’emploie donc rarement directement dans un article ou un document.
2.3. Emphase
1
2
3
4
5
6
7
8
9
10
11
*Ce texte est en italique*
_Ceci est en italique aussi_
**Ceci est en gras**
__Ceci est en gras aussi__
~~Ceci était un texte erroné~~
_Vous **pouvez** les combiner_
***Tout ce texte est important***
Ce texte est en italique
Ceci est en italique aussi
Ceci est en gras
Ceci est en gras aussi
Ceci était un texte erroné
Vous pouvez les combiner
Tout ce texte est important
2.4. Citations (blockquote)
On utilise >.
1
2
3
> Ceci est une première citation.
>> Ceci est une deuxième citation.
>>> Ceci est une troisième citation.
Ceci est une première citation.
Ceci est une deuxième citation.
Ceci est une troisième citation.
2.5. Blocs de code
On utilise ``` ou ~~~.
1
2
3
4
5
```
git status
git add
git commit
```
1
2
3
git status
git add
git commit
On peut préciser le langage pour activer la coloration syntaxique.
1
2
3
4
5
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
1
2
3
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
2.6. Liens
1
2
[GitHub Pages](https://pages.github.com/)
<https://pages.github.com/>
GitHub Pages
https://pages.github.com/
Vous pouvez aussi utiliser des liens relatifs pointant vers d’autres fichiers du dépôt. La syntaxe est la même qu’au terminal.
1
[README](../README.md)
2.7. Listes non ordonnées
On utilise - ou *.
1
2
3
- George Washington
- John Adams
- Thomas Jefferson
- George Washington
- John Adams
- Thomas Jefferson
2.8. Listes ordonnées
On utilise des chiffres.
1
2
3
1. James Madison
2. James Monroe
3. John Quincy Adams
- James Madison
- James Monroe
- John Quincy Adams
2.9. Listes imbriquées
1
2
3
1. Premier élément de liste
- Premier élément imbriqué
- Deuxième élément imbriqué
- Premier élément de liste
- Premier élément imbriqué
- Deuxième élément imbriqué
- Premier élément imbriqué
2.10. Listes de tâches
Pour créer une liste de tâches, ajoutez [ ] devant chaque élément. Pour marquer une tâche terminée, utilisez [x].
1
2
3
- [x] Terminer mes modifications
- [ ] Pousser mes commits sur GitHub
- [ ] Ouvrir une pull request
- Terminer mes modifications
- Pousser mes commits sur GitHub
- Ouvrir une pull request
2.11. Insertion d’images
1
2
3
4
Méthode : {(optionnel) options supplémentaires}
{: .align-center}
{: width="50%" height="50%"}
2.12. Création de tableaux
On peut créer des tableaux avec | et -.
Laissez une ligne vide avant le tableau pour un affichage correct.
Utilisez au moins 3 traits d’union pour une reconnaissance correcte.
1
2
3
4
5
| Left-aligned | Center-aligned | Right-aligned |
| :--- | :---: | ---: |
| git status | git status | git status |
| git diff | git diff | git diff |
| Left-aligned | Center-aligned | Right-aligned |
|---|---|---|
| git status | git status | git status |
| git diff | git diff | git diff |