Maxime BOURIEAU
134 lines
3.4 KiB
Markdown
134 lines
3.4 KiB
Markdown
# Aide-mémoire Markdown
|
|
|
|
Markdown est une syntaxe de mise en forme pour les fichiers `.md`. Ce n'est pas un langage de commandes : les éléments ci-dessous servent à structurer et à présenter le texte. Le rendu de certaines extensions peut varier selon l'application utilisée.
|
|
|
|
## Titres
|
|
|
|
Utiliser de un à six signes `#` au début d'une ligne. Un espace doit suivre les signes.
|
|
|
|
```markdown
|
|
# Titre de niveau 1
|
|
## Titre de niveau 2
|
|
### Titre de niveau 3
|
|
#### Titre de niveau 4
|
|
##### Titre de niveau 5
|
|
###### Titre de niveau 6
|
|
```
|
|
|
|
## Paragraphes et retours à la ligne
|
|
|
|
Laisser une ligne vide entre deux paragraphes pour les séparer.
|
|
|
|
Pour forcer un retour à la ligne sans commencer un nouveau paragraphe, terminer la ligne par deux espaces ou insérer `<br>` si le moteur Markdown l'autorise.
|
|
|
|
## Mise en forme du texte
|
|
|
|
| Résultat | Syntaxe |
|
|
| --- | --- |
|
|
| **Gras** | `**texte**` |
|
|
| *Italique* | `*texte*` |
|
|
| ***Gras et italique*** | `***texte***` |
|
|
| ~~Barré~~ | `~~texte~~` |
|
|
| `Code dans une ligne` | `` `code` `` |
|
|
|
|
## Listes
|
|
|
|
### Liste à puces
|
|
|
|
Utiliser `-`, `*` ou `+` pour créer une puce. Indenter les sous-éléments de deux espaces.
|
|
|
|
```markdown
|
|
- Premier élément
|
|
- Deuxième élément
|
|
- Sous-élément
|
|
```
|
|
|
|
### Liste numérotée
|
|
|
|
```markdown
|
|
1. Première étape
|
|
2. Deuxième étape
|
|
3. Troisième étape
|
|
```
|
|
|
|
Certains outils renumérotent automatiquement la liste à l'affichage. Pour une meilleure compatibilité, saisir les numéros dans l'ordre.
|
|
|
|
### Liste de tâches
|
|
|
|
Cette syntaxe est prise en charge par GitHub et plusieurs éditeurs Markdown :
|
|
|
|
```markdown
|
|
- [ ] Tâche à faire
|
|
- [x] Tâche terminée
|
|
```
|
|
|
|
## Liens et images
|
|
|
|
### Lien
|
|
|
|
```markdown
|
|
[Texte affiché](https://exemple.com)
|
|
```
|
|
|
|
Pour créer un lien vers un autre fichier du dépôt, utiliser un chemin relatif, par exemple `[Procédure](../Dossier/Procedure.md)`.
|
|
|
|
### Image
|
|
|
|
```markdown
|
|
|
|
```
|
|
|
|
Le texte entre crochets décrit l'image et sert notamment aux lecteurs d'écran.
|
|
|
|
## Code et commandes
|
|
|
|
Pour du code ou une commande courte dans une phrase, utiliser des accents graves : `git status`.
|
|
|
|
Pour un bloc de code, entourer le contenu de trois accents graves. Le nom du langage après les accents graves active la coloration syntaxique :
|
|
|
|
```bash
|
|
git status
|
|
git push -u origin main
|
|
```
|
|
|
|
Exemples de marqueurs de langage : `bash`, `powershell`, `text`, `json`, `yaml`.
|
|
|
|
## Citations
|
|
|
|
Faire précéder chaque ligne citée du signe `>` :
|
|
|
|
```markdown
|
|
> Ceci est une citation.
|
|
>
|
|
> Elle peut contenir plusieurs paragraphes.
|
|
```
|
|
|
|
## Tableaux
|
|
|
|
Séparer les colonnes avec `|`. La ligne de tirets sépare l'en-tête du contenu.
|
|
|
|
```markdown
|
|
| Élément | Description |
|
|
| --- | --- |
|
|
| VM | Machine virtuelle |
|
|
| OS | Système d'exploitation |
|
|
```
|
|
|
|
Les deux-points dans la ligne de séparation permettent d'aligner le contenu : `:---` à gauche, `:---:` au centre et `---:` à droite.
|
|
|
|
## Séparateur horizontal
|
|
|
|
Insérer trois tirets sur une ligne vide pour créer une séparation :
|
|
|
|
```markdown
|
|
---
|
|
```
|
|
|
|
## Caractères spéciaux
|
|
|
|
Pour afficher littéralement un caractère utilisé par Markdown, le précéder d'une barre oblique inverse : `\*texte\*` affiche `\*texte\*` au lieu de mettre le texte en italique.
|
|
|
|
## Extensions courantes
|
|
|
|
Certains moteurs prennent aussi en charge les notes de bas de page, les alertes GitHub et les diagrammes Mermaid. Ces éléments ne font pas partie de la syntaxe Markdown de base et peuvent ne pas s'afficher dans tous les lecteurs.
|