3. MarkDown

MarkDown, le langage des fichiers de documentation

3. MarkDown, le langage des fichiers de documentation

MarkDown est un langage de description comme le HTML mais en beaucoup plus simple et limité. Il est utilisé partout pour documenter les projets, entre autres pour le fichier README.md qui doit être nommé en anglais.

Références

Niveaux des titres

# un titre de niveau 1
## un titre de niveau 2
### un titre de niveau 3

Formatage de texte

  • Plus important ou __également important__
  • Quelques mots en italique ou _quelques mots en italique_
  • Pour biffer du texte

Ce texte apparaîtra dans un élément HTML blockquote avec un mot strong

Code

Pour mettre du code dans le texte (balise HTML code) :

Mon texte `code` fin de mon texte

Pour un paragraphe de code, mettre quatre espaces devant :

Première ligne de code
Deuxième ligne

Pour formater tout un paragraphe de code, utiliser 3 accents graves au début et à la fin :

git status
git add
git commit

Retour à la ligne

Pour faire un simple retour à la ligne, mettre deux espaces en fin de ligne (balise HTML br).

Listes

Liste non ordonnée en précédant les items avec * ou - :

* Pommes
* Poires
    * Sous élément avec au moins quatre espaces devant

Liste ordonnée (balise HTML ol) :

1. mon premier
2. mon deuxième

Liens

Pour créer des liens (balise HTML a) :

[texte du lien](url_du_lien "texte pour le titre, facultatif")

Liens relatifs

Par exemple, vous avez un fichier README à la racine du répertoire, et vous avez un fichier docs/CONTRIBUTIONS.md :

Le lien relatif vers CONTRIBUTIONS.md dans votre README ressemblera à ceci :

[Directives pour les contributions à ce projet](docs/CONTRIBUTIONS.md)

Vous pouvez utiliser les opérateurs de liens relatifs tels que ./ et ../

Images

![Texte alternatif](url_de_l'image "texte pour le titre, facultatif")

Exemple :

![Un rectangle gris](http://via.placeholder.com/200x50)

Tableaux

Il faut prévoir une ligne vide avant le tableau pour qu'il se rende bien. Utiliser le caractère pipe | pour créer les cellules et des traits d'union - pour souligner les titres de colonnes.

Les cellules peuvent varier en largeur et n'ont pas besoin d'être parfaitement alignées. Il doit y avoir au minimum 3 traits d'unions sous chaque titre de colonne.

Commandes Description
git status Lister les nouveaux fichiers et les fichiers modifiés
git diff Montrer les différences dans les fichiers qui n'ont pas encore été mis sur la scène staged avec git add
git add Ajouter sur la scène de nouveaux fichiers et des fichiers modifiés en vue du prochain commit

Gestion et collaboration

Pour créer une liste de tâches avec des cases à cocher :

- [ ] Tâche à accomplir
- [x] Tâche complétée

Vous pouvez ajouter un emoji en tapant :EMOJICODE:

Voir cet aide-mémoire : Liste des emojicode

Mentionner un collaborateur ou l'interpeler :

@nmcclure Que penses-tu de ce projet?

Utiliser MarkDown dans VS Code

Utiliser l'extension MarkDown Preview Enhanced de VS Code pour prévisualiser vos fichiers MarkDown.