Points clés
- Catégorie
- Texte et rédaction
- Types d’entrée
- textarea, select, checkbox
- Type de sortie
- html
- Couverture des échantillons
- 4
- API disponible
- Yes
Vue d’ensemble
Ce vérificateur de style et lint Markdown analyse vos documents Markdown pour détecter les erreurs de formatage, les incohérences structurelles et les écarts typographiques, tout en proposant une correction automatique en un clic pour les problèmes les plus courants.
Quand l’utiliser
- •Avant de publier un article de blog ou une documentation technique rédigée en Markdown.
- •Pour harmoniser le style des fichiers README et des wikis au sein d'un projet collaboratif.
- •Lors de la rédaction de contenus bilingues nécessitant le respect des règles de typographie chinoise avec des espacements mixtes.
Comment ça marche
- •Collez votre texte Markdown dans la zone de saisie dédiée.
- •Sélectionnez le jeu de règles souhaité (Défaut, Strict ou Souple) et cochez l'option d'auto-correction si nécessaire.
- •Analysez le rapport détaillé ligne par ligne pour identifier les avertissements et visualisez le document corrigé.
Cas d’usage
Exemples
1. Nettoyage d'un fichier README désordonné
Développeur Open Source- Contexte
- Un projet collaboratif reçoit des contributions avec des styles de listes incohérents et des blocs de code sans indication de langage.
- Problème
- Le fichier README.md contient des marqueurs de liste mélangés (* et -) et des blocs de code non typés.
- Comment l’utiliser
- Coller le contenu du README dans l'outil, choisir le jeu de règles "Défaut" et activer l'auto-correction.
- Configuration d’exemple
-
ruleSet: default, autoFix: true - Résultat
- Les marqueurs de liste sont uniformisés en tirets, les espaces de fin sont supprimés et le rapport signale les blocs de code nécessitant l'ajout d'un langage.
2. Correction typographique d'une documentation bilingue
Rédacteur technique- Contexte
- Une documentation technique rédigée en chinois et en anglais présente des collages de mots sans espaces appropriés.
- Problème
- Les phrases mélangent chinois et anglais sans espace de séparation (ex: "使用Python3开发").
- Comment l’utiliser
- Coller le texte Markdown, sélectionner le jeu de règles "Défaut" avec l'auto-correction activée.
- Configuration d’exemple
-
ruleSet: default, autoFix: true - Résultat
- L'outil insère automatiquement les espaces requis (ex: "使用 Python 3 开发") selon la règle CN001 et corrige les sauts de ligne.
Tester avec des échantillons
markdownHubs associés
FAQ
Quelles règles markdownlint sont prises en charge ?
L'outil valide environ 15 règles clés, dont la cohérence des listes (MD004), les espaces de fin (MD009), les lignes vides (MD012/022/031) et l'absence de langage dans les blocs de code (MD040).
Qu'est-ce que la règle de typographie chinoise CN001 ?
Elle vérifie et ajoute automatiquement un espace de séparation entre les caractères chinois et les caractères latins ou les chiffres.
L'auto-correction risque-t-elle de modifier la structure de mon document ?
Non, l'auto-correction n'applique que des modifications sûres et déterministes comme la suppression des espaces de fin ou l'uniformisation des marqueurs de liste.
Quelle est la différence entre les jeux de règles ?
Le mode Défaut applique les règles standards, le mode Strict ajoute des contraintes comme la longueur de ligne (MD013), et le mode Souple ignore les avertissements de style mineurs.
L'outil convertit-il le Markdown dans un autre format ?
Non, il s'agit d'un outil d'analyse de qualité et de correction de style, pas d'un convertisseur de format.