Introduction à Markdown

Qu'est-ce que Markdown?

Markdown est un langage de balisage utilisé pour formater des documents de tous types, créé par John Gruber et Aaron Swartz en 2004, il est aujourd'hui l'un des langages les plus populaires parmi les programmeurs.

Selon Wikipedia:

REMARQUE: Un langage de balisage est un langage qui utilise tags ou des symboles pour appliquer la stylisation au contenu, les langages de balisage les plus populaires au monde sont HTML, XML et Markdown.

Dans l'image ci-dessous, vous pouvez voir un fichier formaté avec Markdown dans l'éditeur de texte Sublime Text.

Un fichier Markdown ou MD est composé de texte brut, il est facile à comprendre et il n'a pas tout ce balisage HTML qui pollue le contenu.

NOTE: MD est l'abréviation de Markdown.

Avec Markdown, vous pouvez ajouter une mise en forme à votre document à l'aide du balisage de symbole.

Il est important de noter que le format Markdown est différent du format utilisé par certains éditeurs WYSIWYG .

NOTE: WYSIWYG est l'abréviation de What You See Is What You Get . En gros, le formatage du contenu se fait en temps réel, c'est-à-dire qu'il est visible immédiatement. Pour en savoir plus, vous pouvez consulter cet article Wikipédia.

Par exemple, dans Microsoft Word, qui est un éditeur WYSIWYG, le formatage du texte se produit lorsque vous sélectionnez un certain contenu et que vous appuyez sur un bouton spécifique, une combinaison de touches ou une option de menu.

Dans Markdown, le formatage est appliqué à l'aide de symboles tels que le signe dièse #, l'astérisque * et le trait de soulignement _.

Cette symbologie est utilisée par le processeur Markdown pour savoir quels mots / phrases doivent être formatés lors de la conversion de votre fichier en HTML.

Par exemple, ** Je veux que ce texte soit en gras ** et _ce texte en italique_

Trop confus? Simplifions un peu.

Lorsque vous entourez le contenu de deux astérisques ** vous le mettez en gras, dans le deuxième exemple, nous utilisons un trait de soulignement _ pour appliquer les italiques.

Comment modifier un fichier Markdown

Un fichier Markdown n'est rien de plus qu'un texte, donc n'importe quel simple éditeur de texte suffit pour la tâche.

Cependant, il est intéressant de prendre en compte:

• Un éditeur qui vous permet de convertir notre document Markdown dans un autre format.
• Un éditeur qui peut mettre en évidence la syntaxe de Markdown.
• Un éditeur qui montre la conversion en HTML en temps réel

La bonne nouvelle est que:

• Il existe plusieurs applications Markdown pour différents systèmes d'exploitation, y compris, pour Windows, pour Linux, pour Android et même, pour iOS.
• En ce qui concerne Web, les choses s'améliorent encore, plusieurs sites proposent des applications Markdown gratuites pour que vous puissiez éditer vos documents online, et le meilleur de tous, beaucoup ont un convertisseur en temps réel, c'est-à-dire que vous tapez l'application déjà convertie en HTML .

NOTE: Il convient de rappeler que le formatage Markdown est extrêmement simple, par conséquent, un document formaté avec cette langue est toujours lisible.

Markdown contre WYSIWYG

Si un éditeur WYSIWYG (qui offre un formatage en temps réel) est extrêmement pratique, pourquoi devrais-je utiliser Markdown?

Si en utilisant un éditeur WYSIWYG, je peux appuyer sur un bouton et avoir le formatage que je veux, pourquoi vais-je taper un document avec le balisage Markdown?

Regardons quelques raisons d'utiliser Markdown:

• Markdown peut être utilisé pour créer presque n'importe quel type de document, qu'il s'agisse de sites Web, de livres, de présentations, de e-mails, de documentation technique et bien plus encore.
• A portabilidade do Markdown é excepcional. Por ser um documento de texto simples, esse, pode ser editado em qualquer aplicativo de texto. Se contrastarmos com o Microsoft Word, o formato docx é proprietário e necessita de programa específico para ser aberto, o que não acontece com o md.
• Libéré de choisir le programme à utiliser lors de l'édition de vos documents, un fichier " MD" peut être édité n'importe où.
• Quel que soit le système d'exploitation que vous utilisez, Windows, Mac ou Android, Markdown est pris en charge.
• Ayez votre document accessible même en cas de catastrophe. Votre éditeur de texte préféré ne fonctionne plus? Le support a-t-il pris fin? Le programme a-t-il été payé? Pas de problème, choisissez simplement n'importe quel autre éditeur de texte et continuez à éditer et à accéder à votre document, ce qui est extrêmement important pour les fichiers tels que la documentation technique, les livres et les TCC.
• La communauté géante Markdown l'a rendu accessible sur une variété de sites Web en tant que langue standard pour le formatage des articles. GitHub et Reddit sont des exemples de sites célèbres qui utilisent Markdown.
• Un grand nombre de personnes utilisent déjà Markdown, donc leurs documents formatés seront compris par de plus en plus de personnes.

Pratiquant

La meilleure façon d'apprendre est de pratiquer!

Il est intéressant que vous ayez un éditeur Markdown disponible tout en apprenant la syntaxe du langage.

Le moyen le plus rapide de commencer à pratiquer Markdown est d'utiliser les éditeurs online. Avec les applications Web, vous n'avez pas besoin de télécharger quoi que ce soit, allez simplement sur le site Web et commencez à éditer votre fichier md.

StackEdit, Dillinger et Editor.md (Markeditor) sont de bonnes options pour commencer.

NOTE: Ouvrez l'un des éditeurs online dans un autre onglet de votre navigateur pour apprendre la syntaxe de Markdown en temps réel.

StackEdit

Le StackEdit est l'une des applications les plus complètes. En plus de l'éditeur, il fournit également un convertisseur en temps réel qui rend le HTML dans le panneau de droite.

Voir plus d'informations sur StackEdit dans la section outils.

Dillinger

Le Dillinger a une interface très simple, mais il offre plusieurs options pour éditer votre document Markdown. En plus de la conversion en temps réel, vous pouvez également exporter le fichier aux formats HTML et PDF

Pour plus d'informations sur Dillinger cliquez ici.

Editor.md (Markeditor)

Le Editor.md est un outil open source, a un convertisseur MD vers HTML en temps réel et des boutons qui vous permettent de créer un élément Markdown en un seul clic.

Puis?

Après avoir acquis plus d'expérience, vous pouvez télécharger une application pour votre système d'exploitation et commencer à éditer des documents localement.

Dans la section "tools, vous trouverez une liste complète d'applications avec des instructions sur leur utilisation et des informations sur la compatibilité avec les éléments Markdown.

Eh bien, maintenant que vous avez un éditeur disponible pour pratiquer Markdown, comprenons comment la conversion d'un format à un autre fonctionne.

Comment convertir un fichier Markdown

Comprenons la procédure utilisée par les applications Markdown pour convertir votre fichier md dans un autre format, généralement HTML ou PDF.

La simplicité de Markdown

Comment identifiez-vous un fichier Markdown? Par extension, n'est-ce pas? Habituellement md ou markdown.

Un fichier Markdown est du texte brut, n'a pas de formatage, n'est pas un fichier crypté et encore moins compilé.

NOTE: Cette simplicité permet aux programmes d'analyser votre texte pour les symboles qui identifient les éléments Markdown.

Plusieurs applications Markdown, en plus de l'éditeur, ont également un convertisseur intégré. Le convertisseur est responsable de la traduction de la syntaxe de Markdown dans un autre format.

Comment se fait la conversion

Le convertisseur Markdown utilise un Parser pour analyser son contenu à la recherche de marques compatibles avec Markdown; Lorsque Parser trouve une balise compatible, il vérifie s'il existe une correspondance dans le format de sortie, par exemple, un tag HTML qui produit le même formatage.

Ci-dessous vous pouvez voir un exemple de tableau de correspondance entre un marqueur Markdown et un tag HTML.

Notez que le format HTML est l'un des plus utilisés pour convertir Markdown. Votre fichier converti en HTML peut être consulté dans n'importe quel navigateur Web tel que Google Chrome, Mozilla Firefox et Microsoft Edge.

Dans l'image ci-dessous, vous pouvez voir une version simplifiée du processus de conversion.

NOTE: Il est important de noter que, dans une application plus robuste, les composants peuvent être séparés, voire indépendants les uns des autres. L'éditeur, le convertisseur, l'analyseur, etc. L'image ci-dessus n'est qu'une simple représentation de la façon dont la procédure se déroule.

Résumons la conversion en quatre étapes.

• Nous devons d'abord créer un fichier Markdown, pour cela, nous ajoutons l'extension md ou markdown lors de la sauvegarde du document. Lors de l'édition, n'importe quel éditeur de texte fera l'affaire.
• Ensuite, nous chargeons le fichier dans une application Markdown.
• Le moment est venu de passer à un autre format, dans notre cas, HTML. Dans cette étape, une application dédiée à Markdown est indispensable.
• Affichez le résultat de la conversion. S'il s'agit de HTML, ouvrez simplement le fichier dans un navigateur.

Certains points doivent être mis en évidence

• Cette procédure peut varier en fonction de l'endroit où vous modifiez votre fichier Markdown.
• Lorsque nous parlons d'édition simple, c'est-à-dire en utilisant n'importe quel éditeur générique, ces étapes sont plus évidentes.
• Dans le cas des éditeurs online tels que, Dillinger, StackEdit et Editor.md, il y a une fusion des étapes 2, 3 et 4 directement dans l'interface graphique de ces applications.

Utilisation de Markdown

La création de contenu pour Web est le moyen le plus courant d'utiliser Markdown. Non seulement dans la génération de pages HTML, mais aussi dans la création et l'édition d'articles de tous types, de la création de simples commentaires à l'élaboration de la documentation technique.

Vous pouvez également formater des listes de tâches, des messages e-mails, des listes de courses, etc.

Ci-dessous, vous pouvez voir quelques exemples de documents qui peuvent être créés à l'aide de Markdown.

Sites Internet

John Gruber et Aaron Swartz ont développé Markdown en pensant à Internet, donc la création de contenu pour Web est devenue l'une des plus grandes attractions de la langue.

De nombreuses applications, compatibles avec Markdown, convertissent déjà automatiquement leur contenu en HTML.

Vous pouvez créer des sites Web complets en utilisant le formatage Markdown comme base. Si c'est ce que vous voulez faire, des outils comme Jekyll et MkDocs peuvent répondre à vos besoins.

Jekyll et MkDocs sont des outils qui génèrent des sites Web statiques à partir de documents Markdown. Sachez que lors de la création de sites, il est intéressant que vous ayez un minimum de familiarité avec HTML, CSS et même les fichiers de versionnage en utilisant Git.

Les pages GitHub fournissent un hébergement gratuit pour votre site Web statique.

Si vous avez besoin de quelque chose de plus robuste en tant que gestionnaire de contenu, le fameux CMS, jetez un œil à Ghost.

Ghost est une plate-forme gratuite et open source pour bloggers. L'outil dispose également d'un éditeur Markdown intégré.

Utilisez-vous WordPress? Les sites hébergés sur WordPress.com prennent déjà en charge Markdown, mais vous pouvez utiliser plugin Jetpack pour les sites qui se trouvent sur d'autres serveurs d'hébergement.

Mettre en forme du texte

La simplicité de Markdown dispense de toutes les options flashy d'un éditeur WYSIWYG, tel que Microsoft Word, mais il offre encore suffisamment de formatage pour que vous puissiez éditer vos documents.

Les caractères gras, italiques et barrés sont pris en charge par la langue, en plus, bien sûr, des listes, des titres, blockquotes et plus encore.

Un autre avantage du formatage de documents à l'aide de Markdown est la possibilité de les convertir en tout autre format de fichier texte.

Voici une liste d'applications pour créer / éditer des documents Markdown:

• Windows: ghostwriter ou Markdown Monster
• Linux: ReText ou ghostwriter
• Mac: MacDown, iA Writer ou Marked
• Web: Dillinger ou StackEdit
• iOS / Android: iA Writer

Remarques

Markdown est le langage parfait pour la prise de notes.

Vous trouverez ci-dessous une liste des applications compatibles Markdown.

• Notable: se distingue par sa compatibilité avec plusieurs plates-formes.
• Bear: nous sommes entrés sur le territoire de Apple, Bear est compatible avec Mac et iOS, n'utilise pas Markdown par défaut, mais vous pouvez l'activer. Bear est très similaire à Evernote.
• Simplenote: c'est gratuit, c'est simple et ça stocke des notes. Disponible sur toutes les plateformes.
• Boostnote: plus axé sur les programmeurs, en plus d'avoir du code open source.

Et Evernote? OneNote? Quelqu'un...?

Donc c'est...

En ce qui concerne les applications de prise de notes, Evernote et OneNote sont, sans aucun doute, les plus populaires. Malheureusement, les deux programmes, par défaut, ne prennent pas en charge Markdown.

Dans le cas de Evernote, vous pouvez utiliser Markdown Here ou Marxico.

NOTE: Markdown Here est une extension pour votre navigateur qui vous permet de créer emails en utilisant la syntaxe de Markdown. Vous pouvez utiliser cette même extension sur le site Web Evernote.

Livres

Qu'entendez-vous par écrire des livres en utilisant Markdown?

C'est vrai, des services comme Leanpub utilisent des fichiers Markdown comme base, la conversion se fait pour EPUB, MOBI et PDF.

Vous n'aimez pas beaucoup les livres électroniques?

Avec le fichier de votre livre électronique généré, vous pouvez le télécharger sur d'autres services tels que Kindle Direct Publishing et produire des copies physiques.

Présentations slides

Oui, vous avez bien lu, il est possible de créer des présentations slides en utilisant Markdown.

Remark, Cleaver et Landslide sont des outils qui génèrent des présentations de slides directement dans votre navigateur, tous utilisent les fichiers md comme base.

Vous préférez utiliser des applications? Dans macOS, vous pouvez consulter Marked ou Deckset. Sous Windows, nous pouvons convertir Markdown en slides en utilisant Pandoc.

Cela peut sembler une perte de temps de générer des présentations en utilisant le balisage Markdown, cependant, avec un peu de pratique, vous constaterez que c'est beaucoup plus facile et plus rapide que d'utiliser un outil comme PowerPoint ou Keynote.

E-mails

La plupart des fournisseurs de e-mail fournissent un éditeur WYSIWYG intégré à l'interface, mais avouons-le, beaucoup laissent à désirer.

Et maintenant?

Markdown Here est la solution pour ces cas. Une extension pour votre navigateur qui vous permet d'écrire votre e-mails en utilisant le formatage Markdown.

C'est gratuit?

Oui, Markdown Here est gratuit, open source et convertit instantanément Markdown en HTML.

Documentation technique

Markdown et la documentation technique vont de pair. D'innombrables entreprises utilisent des fichiers "af]" md "pour stocker leur documentation.

GitHub a migré ses documents vers Markdown avec le support de l'outil Jekyll. En outre, l'une des archives les plus célèbres au monde, le GitHub README.md est composé de Markdown.

NOTE: GitHub utilise une petite variante de Markdown appelée GitHub-flavored Markdown.

Pour la création de documentation technique, les outils ci-dessous peuvent vous aider:

• Jekyll: Génère de la documentation à partir de fichiers Markdown, est le choix des pages GitHub.
• MkDocs: Simple, rapide et facile à utiliser. La base de la documentation est constituée de fichiers .md, la configuration utilise des fichiers YAML.
• Docusaurus: Générateur de site Web statique, l'un des meilleurs outils pour créer des documents. Docusaurus a été développé par Facebook, prend en charge la gestion des versions, la recherche de documents et même les traductions.
• Read The Docs: Génère des sites de documentation basés sur des fichiers Markdown.
• VuePress: Par son nom, vous comprenez que cela a quelque chose à voir avec Vue, car il est, VuePress est un générateur de sites Web statiques visant à écrire de la documentation technique.

Saveurs de Markdown

Imaginez tous les différents dialectes qui existent dans une seule langue, argot, déclarations, accents. Même pour les locuteurs natifs, il est parfois difficile de comprendre certaines choses.

Eh bien, comme pour les langages, les implémentations de Markdown dans différents programmes peuvent également varier, même si la différence est subtile, cela peut toujours prêter à confusion.

Les variantes de Markdown sont appelées Flavors, par exemple, GitHub utilise une version légèrement plus robuste de Markdown appelée GitHub-flavored Markdown ou GFM.

Certaines applications n'utilisent que syntaxe de base, d'autres utilisent une combinaison de syntaxe de base et syntaxe étendue, et enfin, il y a celles qui implémentent sporadiquement des éléments des deux.

Que faire?

La meilleure façon de comprendre une application est de consulter sa documentation. Vous pouvez également utiliser la bonne vieille tactique d'essai et d'erreur. Voir aussi notre liste d'outils où nous listons quels éléments de Markdown sont compatibles avec chaque application.

En fin de compte, la meilleure option est d'utiliser un programme qui offre la plus grande compatibilité possible, comme Dillinger ou StackEdit.

Quelques exemples de saveurs de Markdown sont, GFM (GitHub-flavored Markdown); MultiMarkdown; Markdown Extra, Kramdown.

Conclusion

Dans cet article, vous avez appris les bases de Markdown, ce que vous pouvez en faire et ses différentes implémentations.

L'étape suivante est d'apprendre la syntaxe de base du langage ou, si vous êtes déjà confiant, consultez la section outils pour commencer à utiliser Markdown.