Markdown Toolbox Logo Markdown Toolbox
Maison
Blog

Feuille de triche - Markdown style GitHub

2023-12-12

GitHub Flavored Markdown (GFM) étend la syntaxe Markdown standard pour inclure certaines fonctionnalités supplémentaires spécifiques à GitHub. Cette feuille de triche couvre les aspects clés de GFM, facilitant la création de README, d'incidents et d'autres documents sur GitHub.

Syntaxe Étendue

Listes de Tâches

  • Créez des listes de tâches avec - [ ] pour une tâche incomplète et - [x] pour une tâche complétée.

    -   [x] Tâche complétée
    -   [ ] Tâche incomplète
    

Barre de Texte

  • Utilisez des doubles tildes ~~ pour rayer du texte.

    ~~Barre de Texte~~
    

Tableaux

  • Créez des tableaux en utilisant des tirets - et des barres |.

    | En-tête 1 | En-tête 2 |
    | -------- | -------- |
    | Ligne 1    | Donnée 1   |
    | Ligne 2    | Donnée 2   |
    

Blocs de Code Délimités

  • Utilisez des accents graves triples (```) et spécifiez une langue pour la coloration syntaxique.

    ```javascript console.log("Bonjour, le monde !"); ```

Mentions d'Utilisateurs et d'Équipes

  • Utilisez @username pour mentionner un utilisateur ou une équipe.

Références aux Problèmes et Demandes de Tirage

  • Référencez les problèmes et les demandes de tirage en utilisant #.

Syntaxe Standard Markdown

Étitres

  • Utilisez # pour les en-têtes. Plus il y a de #, plus les en-têtes sont petits.

Formatage du Texte

  • Gras : **gras**
  • Italique : *italique*
  • Gras et Italique : ***gras & italique***

Listes

  • Liste non ordonnée : Commencez par -, +, ou *.
  • Liste ordonnée : Commencez par des chiffres suivis de ..

Liens et Images

  • Lien : [Titre](URL)
  • Image : ![Texte alternatif](URL)

Citations

  • Utilisez > pour les citations.

Le Markdown de GitHub permet une documentation plus interactive et dynamique, particulièrement utile dans le contexte des projets collaboratifs.