Markdown-inndata

Lint-rapport

Markdown Lint-eksempler

Linteren markerer stilproblemer: lange linjer, overskriftshoppene, blandede listemarkører. Eksempel:

Markdown med vanlige problemer

Lang linje, overskriftshopp (H2 til H3 uten H1), blandede -- og *-listemarkører.

Eksempel

Lim inn i editoren ovenfor for å se lint-rapporten. Bruk Eksempel for å laste inn mer.

Hva er en Markdown Linter?

Markdown er et lett markeringsspråk for dokumenter, README-filer og nettinnhold. En linter sjekker Markdown for stil- og strukturproblemer: inkonsekvent overskriftsnivå, manglende tomme linjer, ødelagte lenker eller formatering som kanskje ikke gjengis som forventet. CommonMark-spesifikasjonen og GitHub Flavored Markdown (GFM) definerer syntaksen.

Verktøyet kjører helt i nettleseren din. Markdown parseres og analyseres lokalt — ingenting sendes til en server. Lint-rapporten lister opp problemer etter linje med alvorlighetsgrad (Feil, Advarsel, Info). For å formatere Markdown, bruk Markdown Formaterer. For validering, bruk Markdown Validator.

Slik bruker du verktøyet

1

Lim inn eller last opp

Lim inn Markdown i venstre editor eller klikk Last opp for å laste inn en .md-, .markdown- eller .txt-fil. Bruk Eksempel for å laste inn eksempeldata med vanlige problemer.

2

Gjennomgå lint-rapporten

Høyre panel viser lint-rapporten med linjenumre og beskrivelser. Fiks problemer i venstre editor; rapporten oppdateres automatisk. Bruk Kopier eller Last ned for å lagre rapporten.

3

Fiks og kjør på nytt

Behandle hvert problem og kjør på nytt. For å konvertere Markdown til HTML, bruk Markdown til HTML. For innholdsfortegnelse fra overskrifter, bruk Markdown TOC Generator.

Når Markdown-linting hjelper

Før du committer dokumenter til GitHub eller publiserer til en CMS, fanger linting opp problemer som kan ødelegge gjengivelsen eller forvirre lesere. Inkonsekvent overskriftshierarki gjør innholdsfortegnelser upålitelige. Ødelagte referansestillenker forårsaker 404-feil. Å kjøre Markdown gjennom her forbedrer kvaliteten før gjennomgang.

Dokumentasjonssider, README-filer og blogginnlegg drar nytte av konsekvent Markdown. For konvertering til HTML for nettbruk, bruk Markdown til HTML. For å generere innholdsfortegnelse fra overskrifter, bruk Markdown TOC Generator. For syntaksreferanse, bruk Markdown Jukseark.

Ofte stilte spørsmål

Er dataene mine private?

Ja. Linting kjører helt i nettleseren din. Ingen data sendes til noen server. Du kan bekrefte dette ved å åpne nettleserens Nettverk-fane.

Hva sjekker det?

Typiske sjekker inkluderer overskriftskonsistens, tomme linjer rundt blokker, listeformatering, lenkevaliditet og CommonMark/GFM-overholdelse. De eksakte reglene avhenger av implementeringen.

Linter vs. validator?

En linter fokuserer på stil og beste praksis. En validator sjekker syntaksriktighet. Bruk begge for kvalitet. Prøv Markdown Validator for validering.

Støtter det GFM?

Mange lintere støtter GitHub Flavored Markdown (tabeller, oppgavelister, gjennomstreking). Sjekk rapporten for GFM-spesifikke problemer.

Kan det fikse problemer automatisk?

Dette verktøyet rapporterer problemer; du fikser dem manuelt. For formatering (mellomrom, linjeskift), bruk Markdown Formaterer.

Relaterte verktøy

For Markdown-syntaks, se CommonMark og CommonMark-spesifikasjonen. GitHub Flavored Markdown utvider den. Markdown Guide tilbyr veiledninger. Se også GitHub, W3C HTML og Jekyll.