Syntaxe Markdown de base
Markdown est un langage de balisage léger avec une syntaxe simple qui vous permet de vous concentrer davantage sur le contenu que sur la mise en forme. Il utilise un format texte brut lisible et modifiable, peut être combiné avec du HTML, et peut être exporté en HTML, PDF ou dans son propre format de fichier .md.
Philosophie de conception
L'objectif de Markdown est « la lisibilité et la facilité d'écriture ».
La lisibilité est la chose la plus importante. Un fichier écrit en Markdown doit pouvoir être publié tel quel en texte brut, sans ressembler à un document rempli de balises ou d'instructions de mise en forme.
L'objectif principal de la syntaxe de Markdown est de la rendre aussi lisible que possible. Sur cette base, les documents Markdown peuvent être publiés en texte brut sans ressembler à des fichiers remplis de balises ou d'instructions de mise en forme.
—— John Gruber
Compatibilité HTML
Le but de la syntaxe Markdown est d'être un langage d'écriture adapté au web.
Markdown ne cherche pas à remplacer HTML, ni même à s'en approcher. Sa syntaxe est limitée et ne couvre qu'un petit sous-ensemble des balises HTML.
Les balises non prises en charge par Markdown peuvent être écrites directement dans le document en HTML. Il n'est pas nécessaire d'indiquer s'il s'agit de HTML ou de Markdown : il suffit d'ajouter les balises.
Par exemple, ajoutez un tableau HTML dans un fichier Markdown :
Ceci est un paragraphe normal.
<table>
<tr>
<td>Foo</td>
</tr>
</table>
Ceci est un autre paragraphe normal.Conversion automatique des caractères spéciaux
Dans les fichiers HTML, deux caractères nécessitent un traitement particulier : < et &.
<est utilisé pour ouvrir les balises&est utilisé pour les entités HTML
Markdown vous permet d'écrire ces caractères naturellement et gère la conversion pour vous. Si le & que vous utilisez fait partie d'une entité HTML, il sera conservé ; sinon, il sera converti en &.
Éléments de syntaxe de base
La syntaxe de base de Markdown inclut les éléments suivants :
Éléments de bloc
- Titres – Utilisez
#pour créer des titres de différents niveaux - Paragraphes et retours à la ligne – Paragraphes de texte et règles de saut de ligne
- Citations – Utilisez
>pour créer des citations - Listes – Listes ordonnées et non ordonnées
- Blocs de code – Format spécial pour afficher du code
- Règles horizontales – Créez des lignes horizontales
Éléments en ligne
- Emphase – Texte en gras et en italique
- Liens – Créez des liens hypertextes
- Images – Insérez des images
- Code en ligne – Marquage de code en ligne
Autres
- Échappement – Échapper les caractères spéciaux
- Autoliens – Reconnaissance automatique des liens
Exemple de syntaxe
Voici un exemple contenant divers éléments de syntaxe de base :
# Mon document
Ceci est un exemple de **texte en gras** et de *texte en italique*.
## Exemple de liste
### Liste de courses
- Pomme
- Banane
- Orange
### Liste de tâches
1. Apprendre les bases de Markdown
2. S'entraîner à écrire
3. Partager avec des amis
> Ceci est un exemple de citation. Markdown rend l'écriture simple et élégante.
Ceci est un [exemple de lien vers la page d'accueil](/fr/).
Exemple de code :Vous pouvez aussi utiliser du code en ligne, comme console.log('Hello World').
Bonnes pratiques
Titres
- Utilisez un seul titre de niveau 1 (
#) par document - Gardez une hiérarchie logique des titres ; ne sautez pas de niveaux
- Laissez des lignes vides avant et après les titres
Mise en forme des listes
- Gardez les symboles de liste non ordonnée cohérents (utilisez uniquement
-,*ou+) - Pas besoin de lignes vides entre les éléments sauf s'il y a plusieurs paragraphes
Liens et images
- Fournissez des descriptions textuelles significatives pour les liens
- Fournissez un texte alternatif pour les images
Affichage du code
- Utilisez le code en ligne pour les courts extraits
- Utilisez des blocs de code pour le code long ou multi-lignes
- Spécifiez le langage pour les blocs de code afin d'activer la coloration syntaxique
Prise en charge des outils
Presque toutes les applications Markdown prennent en charge ces éléments de syntaxe de base. Il peut y avoir de légères différences entre les moteurs Markdown, mais la syntaxe de base est universelle.
Prochaines étapes
Maintenant que vous avez un aperçu de la syntaxe de base de Markdown, vous pouvez :
- Approfondir chaque élément de syntaxe
- Consulter la cheat sheet pour un rappel rapide
- Découvrir la syntaxe étendue pour plus de fonctionnalités
- Explorer l'utilisation avancée et les bonnes pratiques
Commencez à apprendre les éléments de syntaxe spécifiques :