Ilmainen Markdown-linter — Tyylin tarkistus
Liitä Markdown ja saa välittömästi lint-raportti, joka näyttää otsikko-, lista- ja tyyliongelmat.
Syöte-Markdown
Lint-raportti
Markdown Lint -esimerkkejä
Linter merkitsee tyyliongelmat: pitkät rivit, otsikkohypyt, sekalaiset listamarkkerit. Esimerkki:
Markdown yleisillä ongelmilla
Pitkä rivi, otsikkohyppy (H2:sta H3:een ohittaen H1), sekalaiset -- ja *-listamarkkerit.
Liitä yllä olevaan editoriin nähdäksesi lint-raportin. Käytä Esimerkki-painiketta ladataksesi lisää.
Mikä on Markdown Linter?
Markdown on kevyt merkintäkieli dokumentteihin, README-tiedostoihin ja verkkosisältöön. Linter tarkistaa Markdownisi tyyli- ja rakenneongelmien varalta: epäjohdonmukaiset otsikkotasot, puuttuvat tyhjät rivit, rikkoutuneet linkit tai muotoilu, joka ei välttämättä renderöidy odotetulla tavalla. CommonMark-spesifikaatio ja GitHub Flavored Markdown (GFM) määrittelevät syntaksin.
Työkalu toimii kokonaan selaimessasi. Markdownisi jäsennetään ja analysoidaan paikallisesti — mitään ei lähetetä palvelimelle. Lint-raportti listaa ongelmat rivinumeroilla ja vakavuustasolla (Virhe, Varoitus, Info). Markdownin muotoiluun käytä Markdown-muotoilutyökalua. Validointiin käytä Markdown-validaattoria.
Kuinka käyttää tätä työkalua
Liitä tai lataa
Liitä Markdownisi vasempaan editoriin tai napsauta Lataa ladataksesi .md-, .markdown- tai .txt-tiedoston. Käytä Esimerkki-painiketta ladataksesi esimerkkidataa yleisillä ongelmilla.
Tarkista lint-raportti
Oikea paneeli näyttää lint-raportin rivinumeroilla ja kuvauksilla. Korjaa ongelmat vasemmassa editorissa; raportti päivittyy automaattisesti. Käytä Kopioi tai Lataa tallentaaksesi raportin.
Korjaa ja suorita uudelleen
Käsittele jokainen ongelma ja suorita uudelleen. Markdownin muuntamiseen HTML:ksi käytä Markdown HTML:ksi. Sisällysluettelon luomiseen otsikoista käytä Markdown TOC -generaattoria.
Milloin Markdown-lintaus auttaa
Ennen dokumenttien tallentamista GitHubiin tai julkaisemista CMS:ään, lintaus löytää ongelmat, jotka voivat rikkoa renderöinnin tai hämmentää lukijoita. Epäjohdonmukaiset otsikkohierarkiat tekevät sisällysluetteloista epäluotettavia. Rikkoutuneet viittyylisiä linkit aiheuttavat 404-virheitä. Markdownin ajaminen tämän kautta parantaa laatua ennen katselmointia.
Dokumentaatiosivustot, README-tiedostot ja blogikirjoitukset hyötyvät johdonmukaisesta Markdownista. Verkkokäyttöön HTML:ksi muuntamiseen käytä Markdown HTML:ksi. Otsikoista sisällysluettelon luomiseen käytä Markdown TOC -generaattoria. Syntaksiviitteeseen käytä Markdown-pikaopasta.
Usein kysyttyä
Onko datani yksityistä?
Kyllä. Lintaus tapahtuu kokonaan selaimessasi. Mitään dataa ei lähetetä palvelimelle. Voit vahvistaa tämän avaamalla selaimen Verkko-välilehden.
Mitä se tarkistaa?
Tyypillisiä tarkistuksia ovat otsikon johdonmukaisuus, tyhjät rivit lohkojen ympärillä, listan muotoilu, linkin voimassaolo ja CommonMark/GFM-vaatimustenmukaisuus. Tarkat säännöt riippuvat toteutuksesta.
Linter vs. validaattori?
Linter keskittyy tyyliin ja parhaisiin käytäntöihin. Validaattori tarkistaa syntaksin oikeellisuuden. Käytä molempia laadun varmistamiseen. Kokeile Markdown-validaattoria validointiin.
Tukeeko se GFM:ää?
Monet linterit tukevat GitHub Flavored Markdownia (taulukot, tehtävälistat, yliviivaus). Tarkista raportti GFM-kohtaisten ongelmien varalta.
Voiko se korjata ongelmat automaattisesti?
Tämä työkalu raportoi ongelmat; korjaat ne manuaalisesti. Muotoiluun (tyhjätila, rivinvaihdot) käytä Markdown-muotoilutyökalua.
Liittyvät työkalut
Markdown-syntaksiin katso CommonMark ja CommonMark-spesifikaatio. GitHub Flavored Markdown laajentaa sitä. Markdown Guide tarjoaa opetusmateriaaleja. Katso myös GitHub, W3C HTML ja Jekyll.