Markdown Linter
Controleer Markdown-stijl en structuurproblemen
Invoer Markdown
Lint-rapport
Wat is een Markdown Linter?
Een Markdown linter is een kwaliteitstool die Markdown-bestanden analyseert en stijlschendingen, opmaakinconsistenties en structuurproblemen rapporteert die documentatie moeilijk leesbaar en onderhoudbaar maken. Vergelijkbaar met markdownlint op desktop, maar deze browsergebaseerde linter werkt lokaal zonder inhoud te uploaden.
De meeste Markdown linters controleren problemen zoals verkeerd geneste kopniveaus (van H1 direct naar H3 springen), te lange regels, inconsistente lijstmarkeringen en ontbrekende lege regels rond koppen. Het markdownlint-project definieert een uitgebreide regelset die de industriestandaard is geworden.
Door deze problemen vroegtijdig te detecteren, bespaart een Markdown linter tijd bij documentatiebeoordelingen. De browsergebaseerde aanpak biedt directe feedback zonder externe afhankelijkheden — perfect voor het schrijven van documentatie, README's, blogberichten en technische handleidingen.
Hoe gebruik je de Markdown Linter?
Volg deze stappen om Markdown-stijl en -structuur te analyseren. Elke stap gebruikt de werkelijke knoppen en panelen op deze pagina.
Plakken, uploaden of voorbeeldinhoud laden
Plak Markdown in het linker paneel Invoer Markdown, of klik op Uploaden om een .md-bestand te laden. Klik op Voorbeeld om documentatie met opzettelijke stijlproblemen te zien. Controleert kophiërarchie, regellengte, lijstconsistentie en afsluitende spaties.
Lint-rapport bekijken
Het rechter paneel Lint-rapport toont problemen met regelnummers en beschrijvingen. Herstel kopsprongen, lange regels, gemengde lijstmarkeringen en spatiëringsproblemen.
Rapport kopiëren of downloaden
Klik op Kopiëren of Downloaden om het rapport te gebruiken. Gebruik Wissen om opnieuw te beginnen. Alle verwerking vindt in je browser plaats.
Praktische toepassingen
Documentatiebeoordelingsworkflows
Voer de linter uit voor het indienen van pull requests met documentatie-updates om stijlschendingen te detecteren. Teams die grote sites beheren zoals GitHub Docs gebruiken vergelijkbare tools in CI/CD-pipelines.
Technische schrijfstandaarden
Forceer consistente kopstructuur en opmaak in blogberichten, tutorials en handleidingen. Bijzonder belangrijk voor Markdown-gerichte platforms zoals dev.to of Medium.
Open source-projectonderhoud
Controleer of documentatie van bijdragers voldoet aan de stijlgids van het project voor merge. Linting lokaal uitvoeren helpt bijdragers zichzelf te corrigeren. Veel projecten voegen linting toe aan GitHub Actions-workflows.
Snelle kwaliteitscontrole
Gebruik het voor een laatste controle van README-bestanden, API-documentatie en releasenotes voor publicatie. Detecteert gemakkelijk over het hoofd te zien problemen zoals extra spaties en ongeldige kopvolgorden.
Veelgestelde vragen
Wat is het verschil tussen een linter en een validator?
Een validator controleert of de Markdown syntactisch correct is en correct rendert. Een linter gaat verder en dwingt stijlconsistentie en goede praktijken af. Denk aan validatie als spellingcontrole en linting als grammaticacontrole. De markdownlint-documentatie verduidelijkt dit onderscheid.
Kan ik aanpassen welke regels de linter controleert?
Deze browsergebaseerde linter gebruikt een vooraf gedefinieerde regelset gericht op de meest voorkomende problemen. Voor volledige aanpassing staat het desktop-pakket markdownlint toe om specifieke regels in en uit te schakelen via configuratiebestanden.
Stuurt de linter mijn Markdown naar een server?
Nee. Alle linting vindt volledig in de browser plaats met JavaScript. De Markdown-inhoud verlaat nooit de computer. Veilig voor bedrijfseigen documentatie, privéprojecten en gevoelige informatie.
Welk Markdown-dialect ondersteunt deze linter?
Deze linter volgt de CommonMark-specificatie als basis, de meest draagbare en breed ondersteunde Markdown-standaard. GitHub Flavored Markdown breidt CommonMark uit met tabellen en doorhaling.
Hoe herstel ik de door de linter gevonden problemen?
Elk probleem in het rapport bevat een regelnummer en beschrijving. Veelvoorkomende oplossingen: koppen logisch ordenen, afsluitende spaties verwijderen, lege regels rond koppen toevoegen, regels onder 80 tekens houden en consistente lijstmarkeringen gebruiken. De Markdown Guide heeft gedetailleerde voorbeelden.
Kan ik het gebruiken voor productiedocumentatiecontroles?
Voor eenmalige controles, ja. Voor geautomatiseerde handhaving in CI/CD-pipelines, integreer het commandoregelgereedschap markdownlint-cli in je bouwproces.