Markdown-tarkistin
Tarkista Markdown-syntaksi ja löydä yleisiä ongelmia kuten sulkemattomat aidat, rikkinäiset linkit ja virheelliset taulukot — kaikki selaimessa.
Markdown-syöte
Validointiraportti
Esimerkkejä Markdown-tarkistuksesta
Kelvollisessa Markdownissa on oikeat välit ja suljetut koodiaidat. Esimerkkejä:
Kelvollinen Markdown
Virheellinen – otsikon jälkeen puuttuu välilyönti ja koodiaita ei ole suljettu
#API tarvitsee välilyönnin #-merkin jälkeen. Koodilohkolta puuttuu sulkeva ```.
Liitä jompikumpi esimerkki yllä olevaan editoriin. Käytä Esimerkki-painiketta ladataksesi lisää dataa.
Mikä on Markdown-tarkistin?
Markdownilla on syntaksisäännöt. Sulkeutumattomat koodiaidat, rikkinäiset linkit, virheelliset taulukot tai virheellinen HTML voivat aiheuttaa renderöintiongelmia. Markdown-tarkistin tarkistaa dokumentin ja raportoi yleisiä ongelmia. CommonMark-määrittely määrittelee syntaksin.
Työkalu jäsentää Markdownisi ja tuottaa validointiraportin. Se toimii kokonaan selaimessasi. Mitään ei lähetetä palvelimelle. Muotoiluun käytä Markdown-muotoilijaa. Tyylisääntöihin (lint) käytä Markdown-linteriä.
Miten työkalua käytetään
Liitä tai lataa Markdown
Kopioi Markdown ja liitä se vasempaan editoriin. Voit myös napsauttaa Lataa ja avata .md- tai .markdown-tiedoston. Esimerkki-painike lataa esimerkkidataa.
Tarkista validointiraportti
Oikea paneeli näyttää raportin. Siinä luetellaan esimerkiksi sulkeutumattomat aidat, rikkinäiset viitelinkit, virheelliset taulukot tai tyhjät otsikot. Lataa raportti jaettavaksi.
Korjaa ja tarkista uudelleen
Korjaa syötteen ongelmat ja tarkista uudelleen. Muotoiluun käytä Markdown-muotoilijaa. Muunnokseen HTML:ksi käytä Markdown HTML:ksi -työkalua.
Milloin Markdown-tarkistuksesta on hyötyä
Kun julkaiset dokumentaatiota, README-tiedostoja tai sisältöä GitHubiin, GitLabiin tai staattisille sivustoille kuten Jekyll ja Hugo, validointi löytää ongelmia ennen kuin renderöinti menee rikki. GFM-määrittely määrittelee taulukot ja laajennukset. Sulkeutumattomat koodilohkot tai virheelliset taulukot voivat rikkoa kokonaisia sivuja. Markdownin ajaminen täällä antaa varmuutta ennen mergeä tai julkaisua.
Usean kirjoittajan sisältö tai tekoälyn tuottama Markdown sisältää usein hienovaraisia virheitä. Tarkistus täällä antaa tarkistuslistan. Tyylilliselle yhtenäisyydelle (otsikkotasot, listojen muotoilu) käytä Markdown-linteriä.
Usein kysyttyä
Mitä Markdown-validointi tarkistaa?
Se tarkistaa yleisiä ongelmia, kuten ohitetut otsikkotasot (esim. H1:stä H3:een hyppääminen), sulkeutumattomat koodilohkot, virheellinen linkkisyntaksi, epäjohdonmukainen listansisennys ja tyhjät otsikkomerkinnät. Nämä ovat yleisimmät syyt virheelliseen renderöintiin.
Tarkoittaako kelvollinen Markdown, että se renderöityy oikein kaikkialla?
Ei välttämättä. Eri Markdown-renderöijät käsittelevät syntaksia eri tavoin. Validointi perustuu CommonMark-määrittelyyn. GitHub, GitLab ja muut työkalut lisäävät omia laajennuksiaan. Testaa asiakirja siellä, missä se julkaistaan.
Voinko validoida README-tiedoston?
Kyllä — liitä README.md-tiedoston sisältö editoriin ja napsauta Validoi. Tämä on loistava tapa löytää muotoiluvirheet ennen GitHubiin tai GitLabiin pushaamista.
Onko validoinnille kokorajoitus?
Ei. Validointi tapahtuu kokonaan selaimessasi, joten palvelinpuolella ei ole rajoituksia. Erittäin suuret asiakirjat saattavat tarvita hetken enemmän käsittelyaikaa, mutta useimmat README- ja dokumentaatiotiedostot käsitellään välittömästi.
Liittyvät työkalut
Lisätietoja: CommonMark, CommonMark-määrittely, GitHub Flavored Markdown, Markdown Guide, GitHub, W3C HTML, GitLab, Hugo.