Markdown est une syntaxe de mise en forme de texte légère qui transforme du texte ordinaire en documents structurés. Créé en 2004 par John Gruber, il est désormais le format standard pour la documentation, les fichiers README, les articles de blog et la communication des développeurs. Ce guide explique ce qu'est Markdown, pourquoi les gens l'utilisent et comment commencer.
Qu'est-ce que le P_A?
Markdown est un moyen d'ajouter du formatage au texte brut à l'aide de caractères de ponctuation simples. Vous écrivez dans un éditeur de texte, et le Markdown est rendu en sortie formatée (HTML, PDF, etc.) par un processeur.
À titre d'exemple:
# This is a Heading
This is a **bold word** and this is *italic*.
- List item one
- List item twoRendues comme suit:
Ceci est un titre
C' est un En gras ou en noir et ceci est italic.
- Point 1 de la liste
- Point 2 de la liste
Le formatage vit dans le texte lui-même pas de XML caché, pas de format binaire, pas de codage propriétaire.
Pourquoi Markdown a- t- il été créé?
Avant Markdown, les rédacteurs Web étaient confrontés à un choix: écrire en HTML brut (ennuyeux et sujet aux erreurs) ou utiliser un éditeur WYSIWYG qui produisait du code désordonné. John Gruber a conçu Markdown pour être:
- Lisible tel qu'il est Même sans le rendre,
**bold**Lire clairement comme l'accent - Écrit par n'importe qui Pas de logiciel spécial, juste un éditeur de texte
- Convertible à HTML Le format de sortie primaire
La spécification originale était axée sur la production de HTML propres. Mais Markdown s'est depuis propagé à des dizaines de plateformes et de formats de sortie.
Où Markdown est-il utilisé ?
Markdown est partout dans la technologie:
| La plateforme | Ce que fait Markdown |
|---|---|
| GitHub | README, problèmes, requêtes de retrait, wikis |
| Notion | Contenu des pages et documents |
| Obsidian | Toutes les notes sont dans le coffre . |
| Le mot de passe | Publié via le plugin Markdown |
| GitBook | Pages de documentation |
| La décadence / la discorde | Formatage des messages |
| Débordement de pile | Questions et réponses |
| Je ne sais pas . | Les articles de blog et les pages statiques |
| Les carnets de Jupiter | Cellules de documentation |
Si vous écrivez un contenu technique, vous avez presque certainement rencontré Markdown.
Markdown contre Word: Principales différences
| Les aspects | Word | Markdown |
|---|---|---|
| Le format | Nom de l'émetteur | Texte ordinaire (.md) |
| Portée | Requiert Word ou une application compatible | Ouvre dans n'importe quel éditeur de texte |
| Contrôle de version | Difficile (différences binaires) | Facile (différences Git ligne par ligne) |
| Rendu de l'écriture | Intégré dans l'application | Requiert un rendu Markdown |
| Courbe d'apprentissage | WYSIWYG (pas d'apprentissage) | Requiert l'apprentissage de la syntaxe |
| Soutien à la plateforme | Écosystème Microsoft | Outils universels pour les développeurs |
Si vous avez Word documents que vous voulez convertir en Markdown, WordToMD Il s'en occupe instantanément. Pas d'inscription, pas de téléchargement.
Syntaxe de base Markdown
Voici les éléments les plus courants:
Titres
# Heading 1
## Heading 2
### Heading 3Voir aussi: Markdown Guide des rubriques pour la référence complète.
L'accent est mis
**Bold text**
*Italic text*
~~Strikethrough~~Liste de produits
- Unordered item
- Another item
- Nested item
1. First
2. Second
3. ThirdLes liens
[Link text](https://example.com)Des images
Nom de l'établissement
Inline: `code snippet`
Block:
```python
print("Hello, Markdown!")
See [Markdown Code Blocks Guide](/blog/markdown-code-blocks-guide).
### Tables
```markdown
| Name | Role |
|---|---|
| Alice | Developer |
| Bob | Designer |Voir aussi: Markdown Tableaux: un guide complet.
Les quotas de bloc
> This is a blockquote.
> It can span multiple lines.Markdown Des saveurs
Markdown n'est pas une norme unique il existe plusieurs variantes:
- CommonMark Une spécification stricte et sans ambiguïté
- GitHub Aromatisé Markdown (GFM) CommonMark + tables, listes de tâches, coup d'envoi, liens automatiques
- Nom de l'établissement Ajouter des notes de bas de page, des citations et des métadonnées
- Je suis désolée. Le plus riche en fonctionnalités, utilisé par le convertisseur Pandoc
La plupart des plateformes supportent au moins CommonMark. GitHub, Obsidian, et GitBook sont utilisés pour GFM. Pour une référence complète, voir Markdown Syntaxe aide-mémoire.
Comment écrire Markdown
Vous n'avez pas besoin d'un logiciel spécial. Les options sont les suivantes:
- Codifier VS Éditeur gratuit et puissant avec prévisualisation intégrée Markdown
- Obsidian Markdown application de prise de notes avec vue graphique
- Typore Éditeur WYSIWYG Markdown
- iA Écrivain Environnement d'écriture ciblé
- Tout éditeur de texte ordinaire Bloc-notes, édition de texte, vim, emacs
Conversion entre Markdown et autres formats
Si vous avez des documents Word à convertir en Markdown, WordToMD fait en quelques secondes complètement gratuit, sans téléchargement de fichier.
Pour l'inverse (Markdown à Word ou PDF), des outils comme Pandoc gèrent cette conversion. Voir aussi: Pandoc Word à Markdown pour les instructions d'installation.
FAQ
Markdown est un langage de programmation ? - Je ne sais pas. Markdown est un langage de balisage il décrit la mise en forme, pas la logique ou le calcul.
Je peux utiliser Markdown dans Microsoft Word ? Word ne rend pas nativement Markdown, mais il existe des add-ins Word qui ajoutent le support Markdown. Alternativement, convertir Word à Markdown avec WordToMD et utilisez un éditeur Markdown.
Est-ce que Markdown est bon pour les longs documents ? Oui, avec une bonne structure de direction. Les documents très longs bénéficient de la division en plusieurs fichiers (comme dans les coffres GitBook ou Obsidian).
Quelle extension de fichier Markdown utilise-t-il ?
.md est la norme. .markdown est également valable. Certaines plateformes utilisent .mdx pour Markdown avec des composants JSX (Réagir).
Conclusion de l'enquête
Markdown est un format simple et puissant qui est devenu la lingua franca de l'écriture technique. Il est lisible sous forme de texte ordinaire, rend magnifiquement, et fonctionne avec tous les principaux outils de développement. Si vous êtes nouveau, commencez par le Markdown Syntaxe aide-mémoire et essayez de convertir votre premier document Word à WordToMD.