Points clés
- Catégorie
- Développement et Web
- Types d’entrée
- textarea, select
- Type de sortie
- text
- Couverture des échantillons
- 4
- API disponible
- Yes
Vue d’ensemble
Le Linter Markdown est un outil en ligne conçu pour analyser et valider la structure de vos fichiers Markdown. Il détecte instantanément les erreurs de style courantes, telles que les incohérences dans les niveaux de titres, les clôtures de blocs de code manquantes ou les listes mal formatées, en appliquant des jeux de règles personnalisables.
Quand l’utiliser
- •Avant de publier un article de blog ou une documentation technique rédigée en Markdown.
- •Lors de la révision de fichiers README pour s'assurer de la cohérence visuelle des titres et des listes.
- •Pour valider la syntaxe Markdown avant de l'intégrer dans un système de gestion de contenu.
Comment ça marche
- •Collez votre texte Markdown dans le champ de saisie prévu à cet effet.
- •Sélectionnez le jeu de règles souhaité (Standard, Détendu ou Strict) et le format de rapport (Texte ou JSON).
- •Analysez instantanément les résultats pour identifier et corriger les erreurs de style signalées.
Cas d’usage
Exemples
1. Validation d'une documentation technique
Rédacteur technique- Contexte
- Un rédacteur prépare une documentation logicielle volumineuse et veut s'assurer que la structure des titres respecte les standards de publication.
- Problème
- Des sauts de niveaux de titres incorrects rendent le document difficile à lire et à indexer.
- Comment l’utiliser
- Collez le contenu du fichier Markdown dans l'entrée, choisissez le jeu de règles 'Strict' et le format de rapport 'Rapport Texte'.
- Configuration d’exemple
-
ruleSet: strict, reportFormat: text - Résultat
- Le linter affiche une liste claire des lignes contenant des erreurs de hiérarchie de titres à corriger.
2. Nettoyage d'un fichier README communautaire
Développeur Open Source- Contexte
- Un projet reçoit des contributions de plusieurs développeurs, ce qui entraîne des styles de listes et de blocs de code incohérents.
- Problème
- Des blocs de code non fermés cassent le rendu visuel sur la plateforme d'hébergement.
- Comment l’utiliser
- Copiez le code du README dans le champ de saisie, sélectionnez le jeu de règles 'Standard' et le format de rapport 'JSON'.
- Configuration d’exemple
-
ruleSet: standard, reportFormat: json - Résultat
- L'outil génère un rapport JSON listant précisément les lignes où les clôtures de code sont manquantes.
Tester avec des échantillons
markdownHubs associés
FAQ
Quels types d'erreurs ce linter détecte-t-il ?
Il vérifie la hiérarchie des titres, la fermeture des blocs de code, le formatage des listes et d'autres règles de style Markdown.
Quelle est la différence entre les jeux de règles Standard, Détendu et Strict ?
Le mode Strict applique toutes les règles de style, le mode Standard filtre les erreurs courantes, et le mode Détendu ignore les avertissements mineurs.
Puis-je obtenir le rapport d'erreurs au format JSON ?
Oui, vous pouvez choisir le format JSON dans les options pour intégrer facilement les résultats dans d'autres outils.
L'outil nécessite-t-il des dépendances externes ?
Non, le moteur de règles fonctionne de manière autonome et sans aucune dépendance externe.
Mes données Markdown sont-elles stockées sur vos serveurs ?
Non, l'analyse est effectuée localement et vos textes ne sont pas conservés.