Aide-mémoire syntaxe Markdown : du débutant au niveau avancé

Introduction

Markdown est un langage de balisage léger qui vous permet d'écrire des documents en utilisant un format de texte brut facile à lire et à écrire. Cet aide-mémoire couvre toute la syntaxe Markdown du niveau débutant au niveau avancé, avec des exemples pratiques. Que vous soyez novice en Markdown ou que vous souhaitiez consulter une syntaxe spécifique, ce guide vous sera utile.

Syntaxe de base

Titres

Markdown prend en charge six niveaux de titres, en utilisant le symbole # :

# Titre de niveau 1
## Titre de niveau 2
### Titre de niveau 3
#### Titre de niveau 4
##### Titre de niveau 5
###### Titre de niveau 6

Vous pouvez également utiliser la forme soulignée (uniquement pour les niveaux 1 et 2) :

Titre de niveau 1
==================

Titre de niveau 2
------------------

Paragraphes et sauts de ligne

Les paragraphes doivent être séparés par des lignes vides. Si vous avez besoin d'un saut de ligne sans commencer un nouveau paragraphe, ajoutez deux espaces à la fin de la ligne.

Ceci est le premier paragraphe.

Ceci est le deuxième paragraphe.

Ceci est une ligne  
Ceci est la ligne suivante (notez les deux espaces à la fin de la ligne précédente)

Formatage du texte

Effet	Syntaxe	Exemple
Gras	`texte` ou `__texte__`	Texte en gras
Italique	`texte` ou `_texte_`	Texte en italique
Gras italique	`*texte*` ou `___texte___`	*Texte en gras italique*
Barré	`~~texte~~`	~~Texte barré~~
Souligné	`<u>texte</u>`	Texte souligné

Listes

Listes non ordonnées

Utilisez -, + ou * pour créer des listes non ordonnées :

- Élément un
- Élément deux
  - Sous-élément 2.1
  - Sous-élément 2.2
- Élément trois

+ Vous pouvez aussi utiliser le plus
* Ou l'astérisque

Listes ordonnées

Utilisez un nombre suivi d'un point pour créer des listes ordonnées :

1. Premier élément
2. Deuxième élément
   1. Sous-élément 2.1
   2. Sous-élément 2.2
3. Troisième élément

Listes de tâches

Listes de tâches de style GitHub :

- [x] Tâche terminée
- [ ] Tâche à faire
- [ ] Autre tâche à faire

Liens

Liens inline

[Texte du lien](https://www.example.com)
[Lien avec titre](https://www.example.com "Titre du lien")

Liens de référence

[Texte du lien][identifiant-référence]

[identifiant-référence]: https://www.example.com "Titre optionnel"

Liens automatiques

<https://www.example.com>
<[email protected]>

Images

![Texte alternatif](URL-image)
![Image avec titre](URL-image "Titre de l'image")

Image de référence :
![Texte alternatif][référence-image]

[référence-image]: URL-image "Titre optionnel"

Citations

> Ceci est une citation
> qui peut s'étendre sur plusieurs lignes
> 
> > Et même contenir des citations imbriquées

Code

Code inline

Utilisez `des accents graves` pour entourer le code inline

Blocs de code

Utilisez trois accents graves ou une indentation de quatre espaces :

```javascript
function hello() {
    console.log("Hello, World!");
}
```

    Ou utilisez l'indentation (quatre espaces)
    function hello() {
        console.log("Hello, World!");
    }

Séparateurs

Utilisez trois traits d'union, astérisques ou underscores ou plus :

---
***
___

Syntaxe avancée

Tableaux

| Colonne 1 | Colonne 2 | Colonne 3 |
|-----------|-----------|-----------|
| Donnée 1  | Donnée 2  | Donnée 3  |
| Donnée 4  | Donnée 5  | Donnée 6  |

Alignement :
| Gauche | Centré | Droite |
|:-------|:------:|-------:|
| G      | C      | D      |

Notes de bas de page

Ceci est un exemple de note de bas de page[^1].

[^1]: Ceci est le contenu de la note de bas de page.

Listes de définitions

Terme 1
: Définition 1

Terme 2
: Définition 2a
: Définition 2b

Abréviations

HTML est un langage de balisage hypertexte.

*[HTML]: HyperText Markup Language

GitHub Flavored Markdown (GFM)

Coloration syntaxique

Spécifiez la langue dans les blocs de code :

```python
def hello():
    print("Hello, World!")
```

```json
{
  "nom": "exemple",
  "version": "1.1.0"
}
```

Émojis

:smile: :heart: :thumbsup: :star:

Mentions d'utilisateurs et références aux issues

@nomutilisateur
#123 (numéro d'issue)
organisation/dépôt#123

Support HTML

Markdown prend en charge le HTML inline :

<div style="color: red;">
  Ceci est du texte rouge
</div>

<details>
  <summary>Cliquez pour développer</summary>
  Contenu masqué
</details>

Échappement des caractères

Utilisez la barre oblique inverse pour échapper les caractères spéciaux :

\* Pas en italique
\# Pas un titre
\[Pas un lien\]

Caractères nécessitant un échappement :

\ ` * _ {} [] () # + - . ! |

Meilleures pratiques

1. Maintenir la cohérence

Choisissez un style de titre et restez cohérent
Utilisez uniformément * ou - pour les marqueurs de liste
Maintenez une indentation cohérente (généralement 2 ou 4 espaces)

2. Privilégier la lisibilité

Ajoutez des lignes vides avant et après les titres
Séparez les paragraphes par des lignes vides
Évitez les lignes trop longues (recommandé : 80-100 caractères)

3. Utilisation sémantique

Utilisez les titres par niveau hiérarchique, ne sautez pas de niveaux
Utilisez le balisage approprié (listes, citations, etc.)
Fournissez un texte descriptif pour les liens et images

Erreurs courantes

1. Erreur de format de liste

Incorrect :
-Élément un (espace manquant)
- Élément deux

Correct :
- Élément un
- Élément deux

2. Erreur de format de lien

Incorrect :
(Texte du lien)[URL]

Correct :
[Texte du lien](URL)

3. Indentation des blocs de code

Incorrect :
```
code
```

Correct :
```
code
```

Conseils d'outils

Utiliser MD-PDF-WORD

MD-PDF-WORD prend en charge parfaitement toute cette syntaxe Markdown et peut la convertir avec précision aux formats PDF et Word :

Préserve tous les formats
Rend correctement les tableaux
Prend en charge la coloration syntaxique
Gère la typographie française

Raccourcis clavier (éditeurs courants)

Fonction	Windows/Linux	Mac
Gras	Ctrl + B	Cmd + B
Italique	Ctrl + I	Cmd + I
Lien	Ctrl + K	Cmd + K
Code	Ctrl + `	Cmd + `

Ressources d'apprentissage

Spécification officielle : Documentation officielle Markdown
Guide GitHub : Guide GitHub Markdown
Tutoriel interactif : Tutoriel Markdown
Aperçu en ligne : Utilisez la fonction d'aperçu en temps réel de MD-PDF-WORD

Conclusion

Maîtriser la syntaxe Markdown vous permet de créer des documents formatés plus efficacement. Du formatage de texte de base aux tableaux avancés et blocs de code, Markdown offre une syntaxe riche mais concise. Associé à des outils comme MD-PDF-WORD, vous pouvez facilement convertir vos documents Markdown en formats PDF ou Word professionnels, répondant à diverses exigences documentaires.

Rappelez-vous que la philosophie centrale de Markdown est de vous permettre de vous concentrer sur le contenu plutôt que sur le format. Choisissez la syntaxe dont vous avez besoin, restez simple, et rendez vos documents à la fois beaux et faciles à maintenir.

Pratiquez Markdown maintenant

Utilisez l'éditeur en ligne MD-PDF-WORD pour pratiquer cette syntaxe

Ouvrir l'éditeur Installer l'extension