Merkintä arvoon HTML-muunnin
Muunna Markdown-teksti tuotantovalmiiksi HTML-koodiksi live-esikatselun tuella.
Muunna Markdown-teksti tuotantovalmiiksi HTML-koodiksi live-esikatselun tuella.
Markdown on John Gruberin vuonna 2004 luoma kevyt merkintäkieli, jonka avulla kirjoittajat voivat tuottaa strukturoitua HTML-koodia pelkän tekstin käytäntöjen avulla: otsikoiden hash-merkit, korostukset tähdet, luettelot yhdysmerkit ja koodin sisennetyt lohkot. Muoto on tullut oletusasetukseksi README-tiedostoille, tekniselle dokumentaatiolle, blogiluonnoksille, staattisille sivuston luojille ja kaikille konteksteille, joissa tekstin pitäisi olla luettavissa pelkkänä tekstinä ja renderöitynä tulosteena. Markdownin muuntaminen HTML:ksi on renderöintivaihe, joka muuttaa lähteen verkkosivuksi.
Tämä muunnin käyttää merkittyä kirjastoa, JavaScriptin laajimmin käytettyä Markdown-renderöijää. Marked tukee CommonMarkia ja GitHub Flavored Markdownia (GFM), mikä tarkoittaa, että taulukot, aidatut koodilohkot, tehtäväluettelot, yliviivaukset ja automaattinen linkitys toimivat oikein normaalien Markdown-ominaisuuksien lisäksi.
Tulostus on tavallista HTML:ää – semanttiset tunnisteet otsikoille, kappaleille, luetteloille, linkeille ja kuville sekä luokkakoukut koodilohkoille, joissa syntaksin korostustyökalut niitä odottavat. Tulostusliitä selkeästi mihin tahansa sisällönhallintajärjestelmään, upotetaan staattisiin sivustogeneraattoreihin tai toimii erillisenä .html-tiedostona. CSS:ää tai JavaScriptiä ei ole lisätty; tuloksen muotoilu jätetään loppupään kontekstiisi.
Markdown on kirjoittajien ja kehittäjien suosima muoto; HTML on selaimen muotoilema muoto. Useimmat staattiset sivustogeneraattorit ja CMS-alustat muuntavat Markdownin HTML:ksi kulissien takana, mutta joskus tarvitset muuntamisen itsenäisenä vaiheena – liittäminen CMS:ään, jossa ei ole Markdown-tukea, HTML-koodin luominen sähköposteille, nopea esikatselu tai renderoidun tulosteen purkaminen jatkokäsittelyä varten.
HTML on myös kanoninen muoto kaikille selaimessa näytettävälle sisällölle. Markdown-luonnoksia sisältävät sähköpostiuutiskirjeet, suurempiin HTML-sovelluksiin upotetut dokumentaatiosivut ja HTML-koodia odottaviin muokkausohjelmiin liitetyt blogiviestit hyötyvät puhtaasta muunnoksesta.
Liitä Markdown, hanki HTML.
Marked käyttää kaksivaiheista arkkitehtuuria. Lexer tokenisoi syötteen lohkotason tunnuksiksi (otsikot, kappaleet, luettelot, koodilohkot) ja inline-tunnisteiksi (korostus, linkit, kuvat). Jäsentäjä kulkee merkkivirtaa pitkin ja lähettää HTML-koodia soveltaen renderöintikoukkuja jokaiselle merkkityypille.
GitHub Flavoured Markdown -laajennukset ovat oletusarvoisesti käytössä: taulukot (käyttämällä putkisyntaksia), aidatut koodilohkot (kolminkertaiset kielivihjeet), tehtäväluettelot (- [ ] ja - [x]), yliviivaus (käyttäen kaksoistiltoja) ja URL-osoitteiden automaattinen linkitys. Koodilohkot lähettävät valmiiksi käärittyä koodia valinnaisella kieliluokalla syntaksin korostamista varten.
Tuotoksen desinfiointi jätetään jatkokuluttajien tehtäväksi. Marked lähettää mitä tahansa syötettä, mukaan lukien Markdowniin upotettu raaka-HTML. Jos hyväksyt epäluotettavan syötteen, suorita tulos DOMpurifyn tai vastaavan HTML-puhdistusohjelman kautta ennen kuin renderöit sen selaimessa.