Markdown-muotoilutyökalu
Siisti sekava Markdown yhdellä napsautuksella — normalisoi sisennyksen, luettelon välistyksen ja rakenteen johdonmukaisiin, ammattimaisiin dokumentteihin.
Syöte-Markdown
Muotoiltu Markdown
Markdown-muotoilun esimerkkejä
Tiivistetty tai sekava Markdown on vaikea lukea; muotoilu lisää sisennyksen ja rivinvaihdot. Esimerkki:
API-dokumentaatio
Tiivistetty syöte:
Muotoiltu tulos:
Napsauta Esimerkki ladataksesi lisää esimerkkidataa.
Mikä on Markdown-muotoilutyökalu?
Markdown on kevyt merkintäkieli dokumenttien, README-tiedostojen ja verkkosisällön kirjoittamiseen. Epäjohdonmukainen välistys, sekalaiset rivinvaihdot tai sekavat listat tekevät Markdownista vaikea lukea. Markdown-muotoilutyökalu normalisoi sisennyksen, listan välistyksen ja rakenteen niin, että dokumenttisi on siisti ja yhtenäinen. CommonMark-spesifikaatio määrittelee syntaksin.
Tämä työkalu jäsentää Markdownisi ja muotoilee sen uudelleen. Se toimii kokonaan selaimessasi. Mitään ei lähetetä palvelimelle. HTML-muuntamiseen käytä Markdown HTML:ksi-työkalua. Validointiin käytä Markdown-validaattoria.
Kuinka käyttää tätä työkalua
Liitä tai lataa
Kopioi Markdownisi ja liitä se vasempaan editoriin. Voit myös napsauttaa Lataa ladataksesi .md- tai .markdown-tiedoston. Esimerkki-painike lataa esimerkkidataa.
Tarkista tulos
Oikea paneeli näyttää muotoillun Markdownin. Otsikot, listat, koodilohkot ja linkit normalisoidaan. Virheellistä tai epäselvää syntaksia voidaan säilyttää sellaisenaan.
Kopioi tai lataa
Käytä Kopioi tai Lataa. Reaaliaikaista esikatselua varten käytä Markdown-editoria. Sisällysluetteloa varten käytä Markdown TOC -generaattoria.
Milloin Markdown-muotoilu auttaa
Kun muokkaat README-tiedostoja GitHubissa, dokumentaatiota GitHub Docsissa tai useilta kirjoittajilta tulevaa sisältöä, muotoilu normalisoi tyylin. Epäjohdonmukainen listan sisennys tai sekalaiset otsikkotyylit tekevät dokumenteista vaikeammin ylläpidettäviä. Markdownin ajaminen tämän kautta antaa sinulle siistin lähtötilanteen. Katso Markdownin perussyntaksi viitteeksi.
CMS-vienneistä, verkosta kopioidusta tekstistä tai tekoälyn luomasta Markdownista tulevalla sisällöllä on usein sekava välistys. Sen muotoileminen täällä parantaa luettavuutta ennen tallentamista tai julkaisemista. Syntaksiviitteeseen käytä Markdown-pikaopasta.
Usein kysyttyä
Onko datani yksityistä?
Kyllä. Muotoilu tapahtuu kokonaan selaimessasi. Mitään dataa ei lähetetä palvelimelle.
Tukeeko se GitHub Flavored Markdownia?
Muotoilutyökalu käsittelee tavallisen Markdownin. GFM-laajennukset (taulukot, yliviivaus, tehtävälistat) säilytetään yleensä. Täydellisen GFM:n osalta tarkista tulos.
Entä koodilohkot?
Aidatut koodilohkot (kolminkertaiset backtick-merkit) ja sisennetyt koodilohkot säilytetään. Kielitunnisteet pidetään. Muotoilu keskittyy rakenteeseen, ei koodisisältöön.
Voinko muuntaa HTML:ksi?
Kyllä. Käytä Markdown HTML:ksi -työkalua muotoillun tulosteen muuntamiseen. HTML heijastaa siistiä rakennetta.
Muuttaako se merkitystä?
Muotoilu pyrkii säilyttämään semantiikan. Tyhjätila ja rakenne normalisoidaan. Reunatapaukset (esim. epäselvät listat) saattavat renderöityä eri tavalla — esikatsele ennen julkaisemista.
Liittyvät työkalut
Lue lisää: CommonMark, CommonMark-spesifikaatio, GitHub Flavored Markdown, Markdown Guide, GitHub, W3C HTML, GitHub Docs.