Tutoriel Markdown

Markdown est un langage de balisage léger qui permet aux gens d'écrire des documents en utilisant un format de texte brut facile à lire et à écrire.

Le langage Markdown a été créé par John Gruber en 2004.

La philosophie de conception de Markdown est "facile à lire et à écrire", permettant aux gens d'écrire des documents structurés à l'aide d'un simple format de texte brut.

Les documents écrits en Markdown peuvent être exportés vers plusieurs formats tels que HTML, Word, images, PDF et Epub.

L'extension de fichier des documents écrits en Markdown est.md, .markdown。

Les principales caractéristiques de Markdown incluent :

Simplicité: Utilise des symboles intuitifs pour représenter la mise en forme, par exemple, utilisez#pour les titres, et utilisez*pour les éléments de liste. Ces symboles transmettent leur signification visuellement et restent très lisibles même sans rendu.

Lisibilité: Même les documents Markdown sous forme de texte brut peuvent présenter clairement la structure et la hiérarchie du document. Les lecteurs peuvent comprendre comment le contenu est organisé sans avoir besoin d'un logiciel spécialisé.

Portabilité: Les fichiers Markdown sont au format texte brut et peuvent être ouverts et modifiés dans n'importe quel éditeur de texte, sans dépendre d'un logiciel ou d'un système d'exploitation spécifique.

Convertibilité: Peut être facilement converti en HTML, PDF, documents Word et autres formats pour répondre à différents besoins de publication.

Concept de langage de balisage léger

Un langage de balisage est un langage qui utilise des symboles spécifiques pour décrire la structure et la mise en forme d'un document. Les langages de balisage traditionnels comme HTML sont puissants mais ont une syntaxe complexe, tandis que les langages de balisage légers simplifient ce processus.

Comparé à HTML, les avantages de Markdown sont :

  • Faible coût d'apprentissage ; vous pouvez maîtriser la syntaxe de base en quelques minutes
  • Efficacité de rédaction élevée ; nul besoin de saisir des balises complexes
  • Se concentrer sur le contenu plutôt que sur les détails de mise en forme
  • Compatible avec le contrôle de version, facilitant la collaboration et le suivi des modifications

Relation entre Markdown et HTML

Markdown n'est pas un remplacement de HTML, mais une version simplifiée de HTML. En fait, le but ultime de Markdown est d'être converti en HTML. La relation entre les deux peut être comprise comme suit :

Markdown 源码 → 解析器 → HTML 输出 → 浏览器渲染

Par exemple, lorsque vous écrivez :

# This is a heading

Il sera converti en :

<h1>这是一个标题</h1>

Plus important encore, vous pouvez utiliser directement les balises HTML dans Markdown, ce qui offre une flexibilité pour un formatage complexe. Lorsque la syntaxe de base de Markdown ne répond pas à vos besoins, vous pouvez intégrer du code HTML pour obtenir des effets spécifiques.

Pourquoi choisir Markdown

Améliorer l'efficacité de rédaction: Plus besoin d'utiliser fréquemment la souris pour la mise en forme, ce qui préserve la continuité de la pensée. Les rédacteurs peuvent se concentrer sur la création de contenu sans être distraits par des problèmes de mise en forme.

Abaisser le seuil d'apprentissage: Comparé à des langages de balisage tels que LaTeX et HTML, la syntaxe de Markdown est extrêmement simple ; la plupart des gens peuvent maîtriser l'usage de base en une heure.

Compatibilité étendue: Presque tous les éditeurs de texte, éditeurs de code et applications de prise de notes modernes prennent en charge Markdown. Du simple Notepad aux IDE professionnels, vous trouverez Markdown partout.

Compatible avec le contrôle de version: Comme il s'agit d'un format de texte brut, les fichiers Markdown s'intègrent bien aux systèmes de contrôle de version tels que Git, ce qui facilite le suivi de l'historique des révisions des documents et la collaboration en équipe.

Adaptabilité future: Même si un logiciel ou une plateforme particulière disparaît, les fichiers Markdown en texte brut restent accessibles et modifiables, ce qui garantit la disponibilité à long terme du contenu.

Scénarios d'application de Markdown

Rédaction de documentation technique

Dans le domaine du développement logiciel, Markdown est devenu le format standard de la documentation technique. Il est particulièrement adapté à :

  • Documentation API: Une hiérarchie de titres claire et l'affichage des blocs de code rendent les descriptions d'API à la fois professionnelles et lisibles. De nombreux outils de génération de documentation API (tels que Swagger) prennent en charge les descriptions au format Markdown.

  • Description du projet: Des guides d'installation aux manuels utilisateur, Markdown permet d'organiser efficacement les informations techniques. Les exemples de code, les fichiers de configuration et les opérations en ligne de commande peuvent tous être affichés correctement.

  • Normes de développement: les normes de codage de l'équipe, les directives de conception, les flux de travail, etc. peuvent tous être rédigés en Markdown pour faciliter la consultation et la mise à jour par les membres de l'équipe.

Création d'articles de blog

La plupart des plateformes de blog modernes et des générateurs de sites statiques prennent en charge Markdown :

  • Gestion de contenu: les blogueurs peuvent se concentrer sur la création de contenu sans se soucier d'un codage HTML complexe. Le formatage des articles se fait avec des marqueurs simples.

  • Migration de plateforme: les articles écrits en Markdown peuvent être facilement migrés entre différentes plateformes sans être enfermés par des formats spécifiques à une plateforme.

  • Rédaction hors ligne: les articles peuvent être rédigés hors ligne dans n'importe quel éditeur de texte, puis publiés par lots, ce qui accroît la flexibilité de rédaction.

Fichier README GitHub

La plateforme GitHub utilise largement Markdown, en particulier pour les fichiers README de projet :

  • Présentation du projet: présente clairement les informations clés telles que l'objectif du projet, ses fonctionnalités et son utilisation.

  • Guide d'installation: fournit des étapes détaillées d'installation et de configuration au moyen de blocs de code et de listes.

  • Guide de contribution: explique comment participer au développement du projet, notamment les normes de code, les processus de soumission, etc.

  • Suivi des problèmes: dans les Issues et les Pull Requests, les développeurs utilisent Markdown pour décrire les problèmes et proposer des solutions.

Prise de notes et gestion des connaissances

Markdown devient le format préféré pour les notes numériques :

  • Notes d'étude: prend en charge divers types de contenu tels que les formules mathématiques, la coloration syntaxique du code et les graphiques, adaptés à l'apprentissage technique et à l'organisation des connaissances.

  • Notes de réunion: Une structure de titres claire et un format de liste rendent les points clés d'une réunion clairs en un coup d'œil.

  • Construction d'une base de connaissances: Les entreprises et les particuliers utilisent Markdown pour construire des bases de connaissances, en organisant l'information par des liens et des étiquettes.

Plateformes d'écriture en ligne

De plus en plus de plateformes d'écriture commencent à prendre en charge Markdown :

  • GitHub, Jianshu, Zhihu: Les éditeurs de ces plateformes prennent en charge la syntaxe Markdown, ce qui permet aux créateurs de mettre en forme rapidement leurs articles.

  • GitBook、Notion: Des plateformes professionnelles de documents et de notes qui prennent en charge nativement Markdown et offrent de puissantes fonctionnalités d'organisation et de collaboration.

  • Générateurs de blogs statiques: Des outils tels que Jekyll, Hugo et Hexo permettent aux utilisateurs de créer des sites web professionnels avec Markdown.

Livres utiles

"Amazing Markdown" :

Autres extensions