Guide du Markdown pour débutants : tout ce que vous devez savoir pour commencer

Table des matières

• Qu’est-ce que le Markdown ?
  • Avantages de l'utilisation de Markdown
• Premiers pas avec Markdown
  • Formatage de base dans Markdown
  • Formatage avancé dans Markdown
• Applications du monde réel sur Markdown
• Ressources

La capacité de présenter vos pensées et vos idées de manière claire et concise est importante, quel que soit le secteur dans lequel vous travaillez. Heureusement, il existe une multitude d'outils et de technologies qui vous aident à créer un bon contenu textuel.

Entrez Markdown – un langage de balisage polyvalent mais sans prétention qui est devenu un incontournable pour les écrivains, les programmeurs et les créateurs de contenu de toutes sortes.

Si vous êtes nouveau dans le domaine de Markdown, n'ayez crainte ; ce guide est conçu pour être votre boussole dans votre voyage vers la maîtrise de ce langage de balisage convivial.

Qu’est-ce que la démarque ?

Markdown est un langage de balisage léger qui simplifie le processus de formatage du texte pour le Web et d'autres supports. Il a été créé par John Gruber et Aaron Swartz en 2004 pour rédiger du contenu pouvant être facilement converti en HTML et dans d'autres formats sans nécessiter de connaissances techniques approfondies.

Il est particulièrement populaire parmi les écrivains, les blogueurs, les programmeurs et tous ceux qui ont besoin d'un moyen simple et efficace de formater du texte pour le Web.

Avantages de l'utilisation de Markdown

1. Simplicité et lisibilité : Markdown utilise une syntaxe simple utilisant des caractères de texte brut. Cette simplicité le rend facile à apprendre et à utiliser, vous permettant de vous concentrer sur le contenu lui-même plutôt que sur des codes de formatage complexes.

2. Indépendance de la plateforme : Markdown est indépendant de la plateforme. Vous pouvez créer des documents Markdown sur n'importe quel appareil à l'aide d'un éditeur de texte ou d'un éditeur de code, et ces documents peuvent être facilement visualisés et convertis en différents formats sur différentes plates-formes. Cette cohérence garantit l'accessibilité et la longévité de vos contenus.

3. Courbe d'apprentissage rapide : Markdown possède l'une des syntaxes les plus simples. Cela signifie que vous pouvez l'apprendre en peu de temps. La syntaxe est intuitive et ressemble au formatage que vous utilisez peut-être déjà dans les e-mails ou les messages texte.

Cette courbe d'apprentissage rapide encourage l'adoption par ceux qui sont des utilisateurs non techniques.

4. Large adoption : Markdown a acquis une immense popularité et est pris en charge sur une multitude de plates-formes, notamment des systèmes de blogs comme WordPress, des outils de collaboration comme GitHub et des systèmes de gestion de contenu. Cela fait de Markdown une compétence précieuse qui peut être appliquée dans de nombreux contextes.

5. Vitesse et efficacité : la création de contenu dans Markdown est rapide et efficace. Avec quelques caractères simples et autres éléments de formatage. Ceci, en retour, permet à ses utilisateurs de créer des documents avec simplicité, efficacité et rapidité.

6. Contrôle de version : lorsque vous utilisez Markdown en collaboration avec des systèmes de contrôle de version comme Git, les modifications apportées aux fichiers Markdown sont faciles à suivre. Cela simplifie la collaboration sur les projets, la révision des modifications et la conservation d'un enregistrement clair des modifications.

Premiers pas avec Markdown

Markdown fonctionne dans une variété d'éditeurs de texte et d'éditeurs de code. Pour le bien de cet article, nous nous concentrerons sur l'utilisation du markdown dans les éditeurs de code, en particulier VS Code . Cependant, la même syntaxe peut être suivie dans les éditeurs de texte.

1. Tout d'abord, dans votre VS Code, créez un dossier (vous pouvez le nommer comme vous le souhaitez). Dans ce dossier, créez un fichier appelé markdown.md

   
   

2. Accédez à la section supérieure droite de votre fichier VS Code et cliquez sur le bouton d'aperçu pour obtenir un aperçu de votre résultat côte à côte.

   

Formatage de base dans Markdown

Voici quelques-unes des syntaxes de base pour formater le texte dans Markdown.

1. En-têtes : les en-têtes sont utilisés pour indiquer différents niveaux de titre dans votre document. Pour créer des en-têtes dans Markdown, utilisez le symbole # suivi d'un espace puis de votre texte d'en-tête. Notez que le nombre de symboles # détermine les niveaux de votre titre. Voir l'exemple ci-dessous.

    # Heading ## Heading ### Heading 

   

2. Accentuation : vous pouvez mettre l'accent sur votre texte en le mettant en gras ou en italique. Pour mettre le texte en gras, entourez-le de doubles astérisques ** ou de doubles traits de soulignement __ . Pour mettre le texte en italique, placez-le entre des astérisques simples * ou des traits de soulignement simples _ .

Exemple:

 This is the **Bold Text** This is *italics* 

3. Listes : Markdown prend en charge les listes ordonnées (numérotées) et non ordonnées (à puces). Pour créer une liste ordonnée, commencez chaque élément par un nombre suivi d'un point. Pour créer une liste non ordonnée, utilisez soit un astérisque * , plus + ou des traits d'union - .

Exemple:

 Ordered List: 1. First item 2. Second item 3. Third item Unordered List: * Item 1 * Item 2 * Item 3 

4. Liens : vous pouvez créer des hyperliens dans Markdown en utilisant des crochets [] pour le texte du lien et des parenthèses () pour l'URL du lien.

Exemple:

 [Visit Odafe's Website](https://www.odafe.vercel.app)

5. Images : l'insertion d'images est similaire à la création de liens ; la seule différence est un point d'exclamation ! devant les crochets. Le texte alternatif entre crochets est utilisé pour décrire l’image à des fins d’accessibilité.

Exemple:

 ![Alt text](image-url.jpg)

6. Blockquotes : Les blockquotes sont utilisés pour afficher les textes de citations. Pour créer cela, commencez simplement la ligne avec le symbole > suivi du texte que vous souhaitez citer.

Exemple:

 > This is a quote by Odafe

Le résultat ressemble à ceci :

Ceci est une citation d'Odafe

7. Règle horizontale : Vous pouvez ajouter des séparateurs horizontaux en utilisant simplement trois traits de soulignement _ .

Exemple:

 This is a regular text ____ This is more regular text 

Ce sont les éléments fondamentaux du formatage de base dans Markdown. En maîtrisant ces concepts, vous serez en mesure de créer un contenu bien structuré et visuellement attrayant, que vous rédigiez une simple note ou que vous rédigiez un document plus complexe.

Formatage avancé dans Markdown

Markdown offre également des fonctionnalités supplémentaires dans les cas où vous pourriez avoir besoin d'ajouter des éléments plus complexes à votre document. Certaines de ces options de formatage sont :

1. Blocs de code et code en ligne : vous pouvez facilement ajouter des blocs de code à votre fichier en démarrant vos blocs de code avec trois backticks (```) suivis de la langue dans laquelle votre bloc de code est écrit. Les codes en ligne sont ajoutés en encapsulant l'extrait de code. en backticks simples.

Exemple:

 This is a HTML element `<div>Hello World</div>` ```javascript function myFunction() { console.log("Hello world!") } 

2. Listes de tâches : les listes de tâches sont utiles pour créer des listes de tâches. Pour créer une liste de tâches, utilisez des crochets avec un « x » pour les tâches terminées et un espace pour les tâches incomplètes.

Exemple:

 - [x] A complete task - [ ] An incomplete task 

3. Emojis : Il existe deux façons d'ajouter des emoji aux fichiers Markdown : copiez et collez l'emoji dans votre texte au format Markdown ou saisissez des codes courts emoji .

4. Texte barré : pour barrer du texte, utilisez des doubles tildes ( ~~ ) autour du texte que vous souhaitez barrer.

Exemple:

 This is a ~~Strikethrough~~ text.

5. Caractères d'échappement : si vous devez afficher des caractères ayant une signification particulière dans Markdown, vous pouvez les échapper à l'aide d'une barre oblique inverse ( \ ).

 To display a literal asterisk \* use a backslash before it.

6. Exposant et indice : pour créer un exposant, le texte en exposant est entouré de deux symboles ^ .

Pour créer du texte en indice, le texte est entouré de deux symboles ~ .

Exemples:

 This is how a superscript is written: X^2^ This is how a subscript is written: H~2~O. 

7. Tableaux : Pour créer des tableaux dans Markdown, suivez ces étapes :

• Commencez et terminez chaque ligne par un symbole de barre verticale ( | ).
• Séparez chaque colonne par un symbole de barre verticale ( | ).
• Utilisez au moins trois tirets ( --- ) pour créer des en-têtes de colonne.

 | Syntax | Description | | ----------- | ----------- | | Header | Title | | Paragraph | Text |

Sortir:

8. Surligner : vous pouvez surligner les mots importants dans votre document en utilisant deux signes égal ( == ) avant et après le(s) mot(s).

Exemple:

 This highlighted word is ==Bee==

Sortir:

9. Notes de bas de page : Les notes de bas de page sont un moyen d'ajouter des notes et des références à la fin de votre document sans encombrer le corps principal. Pour créer une référence de note de bas de page, ajoutez un symbole caret ( ^ ) et un identifiant unique (généralement des chiffres ou des mots) entre parenthèses ( [^1] ).

Les identifiants ne peuvent pas contenir d'espaces ou de tabulations. Dans le résultat, les notes de bas de page sont numérotées de manière séquentielle.

Exemple:

 This is an example sentence with a footnote[^1]. [^1]: This is the content of the footnote.

Le résultat:

Vous pouvez en savoir plus sur le formatage avancé dans Markdown ici.

Applications du monde réel sur Markdown

Markdown a gagné en popularité parmi les développeurs de logiciels et la communauté des programmeurs. Il a notamment trouvé un rôle central au sein des plateformes de contrôle de version, servant de moyen complet et accessible pour expliquer l’essence d’une base de code.

En utilisant Markdown comme moyen de décrire les subtilités de leur code, les développeurs créent un mélange harmonieux de clarté et de contexte.

Cette pratique tend un coup de main à ceux qui tombent sur leur référentiel de code, facilitant une compréhension rapide et approfondie de l'objectif général et des nuances du projet.

De cette manière, Markdown se présente non seulement comme un outil de formatage, mais aussi comme un puissant communicateur, comblant le fossé entre les efforts de codage complexes et leurs profondes implications dans le monde réel.

Conclusion

N'oubliez pas que Markdown n'est pas seulement un outil ; c'est un pont qui relie vos pensées à un public mondial, permettant à votre voix d'être entendue avec clarté et impact.

Sa compatibilité avec diverses plateformes, sa simplicité et son adaptabilité garantissent que votre voyage avec Markdown ne se limite pas à ce guide mais se poursuit à mesure que vous explorez de nouvelles façons de vous exprimer et d'exprimer vos idées.

Ressources

• Aide-mémoire : https://www.markdownguide.org/cheat-sheet/

• Tutoriel : https://www.markdowntutorial.com/

• Tutoriel : https://commonmark.org/help/tutorial/

  
  

Également publié ici