Titres et sous-titres
Ajoutez une espace après les #. Le nombre de # indique le niveau du titre, de 1 à 6.
Un doute sur un tableau, une liste ou un lien ? Retrouvez l’exemple qu’il vous faut, modifiez-le et vérifiez le résultat en direct. Copiez ensuite le Markdown ou le texte mis en forme. Certaines syntaxes étendues dépendent de l’éditeur utilisé.
Ajoutez une espace après les #. Le nombre de # indique le niveau du titre, de 1 à 6.
Laissez une ligne vide avant les trois tirets pour éviter de transformer la ligne précédente en titre.
Placez une barre oblique inverse (antislash) devant un caractère Markdown pour l’afficher tel quel.
Utilisez - [ ] pour une case à cocher vide et - [x] pour une tâche terminée.
Le texte entre crochets décrit le lien ou l’image. Une image commence par un point d’exclamation.
Définissez les adresses en fin de document pour les réutiliser sans alourdir le texte.
Entourez une commande d’accents graves (`). Pour un bloc de code, utilisez trois accents graves et indiquez le langage, par exemple js.
Les deux-points dans la ligne de séparation règlent l’alignement : à gauche, au centre ou à droite.
Ces extensions sont prises en charge dans cet aperçu. Leur rendu peut varier dans un autre éditeur Markdown.
Gardez le mot-clé warning en anglais entre les marqueurs ::: et rédigez le contenu en français.
Présentez votre projet avec les instructions d’installation, un exemple d’utilisation et les modalités de contribution.
Gardez une trace des décisions et répartissez les actions avec un responsable et une échéance pour chacune.
Clarifiez le besoin, les livrables, le périmètre et les critères de réussite avant de lancer le projet.
Donnez les informations nécessaires pour reproduire le problème : environnement, étapes, résultat attendu et message d’erreur.
Résumez les nouveautés, les corrections et les éventuelles actions à prévoir lors de la mise à jour.