Markdown-lint
Controleer Markdown op stijl- en syntaxisproblemen met markdownlint, de linter die door veel editors en CI-pipelines wordt gebruikt. Plak een document en krijg elke bevinding met het regelnummer, een regel zoals MD001 en een uitleg. Je kunt ook een gecorrigeerde versie opvragen waarin markdownlint aanpast wat het kan, zoals lege regels, lijstmarkeringen en spatiëring.
Veelgestelde vragen
Welke regels worden gecontroleerd?
Alle regels die markdownlint standaard inschakelt, van MD001 (kopniveaus lopen telkens met één op) tot regels voor lijsten, lege regels, codeblokken, links en nadruk. De regel voor regellengte, MD013, staat uit tenzij je een maximale regellengte instelt.
Hoe schakel ik regels uit?
Vermeld ze in het veld voor uit te schakelen regels, gescheiden door komma's of spaties, met nummers zoals MD033 of namen zoals no-inline-html. Opmerkingen in het document zelf, zoals <!-- markdownlint-disable MD033 -->, werken ook.
Wat doet de hersteloptie?
Deze past de automatische correcties van markdownlint toe, zoals lege regels rond koppen en lijsten toevoegen, lijstmarkeringen consistent maken of afsluitende spaties verwijderen, en toont het gecorrigeerde document. Bevindingen waarvoor geen automatische correctie beschikbaar is, moet je zelf oplossen.
Welke versie van markdownlint wordt gebruikt?
markdownlint 0.42.0, de bibliotheek waarop de markdownlint-extensie voor Visual Studio Code en markdownlint-cli2 zijn gebouwd. Met dezelfde versie en standaardconfiguratie melden ze dezelfde bevindingen.
Waarom geeft het een melding over mijn eerste kop?
Regel MD041 verwacht dat een document begint met een kop op het hoogste niveau, en MD025 staat er maar één toe. Als je platform de titel zelf toevoegt, schakel die regels dan uit voor je document.
Hoeveel bevindingen worden getoond?
Het totaal wordt altijd gemeld en de eerste 500 bevindingen staan in de tabel. Los de eerste op en voer de controle opnieuw uit om de rest te zien.