Markdown on laajasti käytetty tekstipohjainen merkintäkieli, jonka avulla asiakirjoja voidaan muotoilla helposti luettavassa muodossa ilman monimutkaisia graafisia käyttöliittymiä. Markdown-syntaksin etuna on sen selkeys: teksti säilyy ihmisluettavana sellaisenaan, mutta se on vaivattomasti muunnettavissa muiksi julkaisumuodoiksi.
Asiakirjojen muuntaminen eri alustoille sopiviksi on välttämätöntä, sillä eri vastaanottajat ja järjestelmät vaativat erilaisia tiedostomuotoja. Kirjoittajat, joiden on toimitettava README-tiedostoja, ohjeita, muistiinpanoja tai artikkeleita, kohtaavat usein tilanteita, joissa vastaanottaja edellyttää perinteistä Microsoft Word (.docx) -asiakirjaa tai verkkosivuille sopivaa HTML-koodia. Tämä työkalu ratkaisee yhteensopivuusongelmat muuntamalla Markdown-tekstin suoraan näihin yleisiin formaatteihin.
Markdown-rakenteen muuntaminen Word-asiakirjaksi
Microsoft Word -asiakirjat (.docx) perustuvat monimutkaiseen XML-pohjaiseen rakenteeseen. Kun Markdown-tekstiä muunnetaan Word-muotoon, työkalun on tulkittava Markdown-merkinnät ja kohdistettava ne vastaaviin Wordin tyyleihin ja elementteihin.
Muunnoksessa tuetaan seuraavia yleisimpiä Markdown-rakenteita:
- Otsikot: Markdown-otsikkotasot (H1–H6) muunnetaan vastaaviksi Word-otsikkotyyleiksi. Työkalu määrittää vietävän Word-asiakirjan tiedostonimen automaattisesti Markdown-tekstissä olevan ensimmäisen H1-otsikon perusteella.
- Luettelot: Sekä järjestetyt (numeroidut) että järjestämättömät luettelot muuttuvat Wordin luettelomuotoiluiksi. Myös tehtäväluettelot säilyvät muunnoksessa.
- Taulukot: Markdown-taulukot muunnetaan Word-taulukoiksi, joissa sarakkeet ja rivit jäsentyvät oikein.
- Linkit: Tekstissä olevat hyperlinkit muunnetaan toimiviksi Word-linkeiksi.
- Koodilohkot: Ohjelmointikoodia sisältävät lohkot muotoillaan Wordiin sopivalla tavalla erottumaan muusta tekstistä.
- Korostukset: Lihavoinnit ja kursivoinnit siirtyvät Word-asiakirjaan vastaavina tekstityyleinä.
Word-vientiä koskee kokorajoitus. Jos syötetty Markdown-teksti on liian suuri paikalliseen Word-vientiin, käyttöliittymässä näytetään virheilmoitus: "Tämä Markdown-teksti on liian suuri paikalliseen Word-vientiin. Pidä pituus alle {max} merkin.". Jos muunnos epäonnistuu muusta syystä, järjestelmä ilmoittaa: "Muunnos epäonnistui. Kokeile pienempää Markdown-asiakirjaa.".
Puhtaan HTML-koodin edut ja rakenne
HTML-muunnoksessa työkalu tuottaa niin sanottua puhdasta HTML-koodia. Puhtaalla HTML-koodilla tarkoitetaan semanttista ja selkeää merkintää, joka ei sisällä ylimääräisiä tyylimäärittelyjä, inline-muotoiluja tai tarpeettomia elementtejä, joita monet graafiset tekstinkäsittelyohjelmat usein luovat. Puhtaan HTML-koodin etuna on sen helppo ylläpidettävyys, nopea latautuminen verkkosivuilla ja vaivaton integroitavuus olemassa oleviin sisällönhallintajärjestelmiin.
Ladattava HTML-tiedosto on yksinkertainen itsenäinen asiakirja. Tietoturvan ja verkkostandardien noudattamiseksi työkalu käsittelee linkkejä ja raakaa koodia seuraavasti:
- Linkkien suojaus: Kaikkiin esikatselussa ja HTML-tulosteessa oleviin linkkeihin lisätään automaattisesti määreet
noopener noreferrer. Tämä estää tietoturvariskejä ja parantaa suorituskykyä, kun linkkejä avataan uusiin välilehtiin. - HTML-suojaus: Markdown-tekstin sisällä mahdollisesti oleva raaka HTML-koodi suojataan (escaped) ennen hahmontamista HTML-vientiin. Tämä estää haitallisen koodin suorittamisen selaimessa.
Paikallinen käsittely ja tietosuoja
Tietosuoja on keskeinen tekijä asiakirjojen käsittelyssä. Tämän työkalun kohdalla kaikki Markdown-tekstin käsittely tapahtuu paikallisesti käyttäjän omassa selaimessa.
Markdown-tekstiä ei ladata BroBroGo-palvelimelle. Reaaliaikainen esikatselu, HTML-vienti ja Word-asiakirjan (.docx) luominen suoritetaan kokonaan paikallisesti selaimen sisällä. Tämä varmistaa, että käsiteltävä teksti pysyy vain käyttäjän omassa laitteessa käsittelyn aikana.
Työkalun käyttöliittymä ja toiminta
Käyttöliittymä tarjoaa reaaliaikaisen näkymän kirjoitettavaan tekstiin sekä sen tilastoihin. Kun kirjoitat tai liität tekstiä kenttään, jonka otsikkona on "Kirjoita Markdown-tekstiä", työkalu laskee automaattisesti tekstin pituuden. Tilastot näytetään yksiköissä "Sanaa" ja "Merkkiä".
Jos syötealue on tyhjä, esikatselualueella näkyy teksti: "Muotoiltu esikatselu ja HTML ilmestyvät tähän.". Jos yrität viedä tiedostoa tyhjästä editorista, työkalu antaa ilmoituksen: "Ei mitään vietävää – kirjoita ensin Markdown-tekstiä.".
Kun editori tyhjennetään painamalla "Tyhjennä"-painiketta, tilaksi muuttuu "Editori tyhjennetty." ja merkkilaskuri nollautuu.
| Toiminto | Kuvaus |
|---|---|
| Lataa Word-tiedosto | Luo ja lataa.docx-tiedoston paikallisesti. |
| Lataa HTML | Lataa itsenäisen.html-tiedoston. |
| Kopioi HTML | Kopioi luodun HTML-koodin suoraan leikepöydälle. |
Usein kysytyt kysymykset (FAQ)
Ladataanko Markdown-tekstini palvelimelle?
Ei. Esikatselu, HTML-vienti ja Word-asiakirjan luominen tapahtuvat täysin paikallisesti selaimessasi.
Mitä Word-vienti säilyttää?
DOCX-vienti säilyttää yleisimmät Markdown-rakenteet, kuten otsikot, luettelot, taulukot, linkit, koodilohkot, korostukset ja tehtäväluettelot.
Sisältääkö HTML-vienti turvattomia skriptejä?
Ei. Markdown-tekstin sisällä oleva raaka HTML suojataan ennen hahmontamista, ja ladattava HTML on yksinkertainen itsenäinen asiakirja.
Miten vietävän Word-tiedoston nimi määräytyy?
Työkalu määrittää vietävän Word-asiakirjan tiedostonimen automaattisesti Markdown-tekstissä olevan ensimmäisen H1-otsikon perusteella. Jos otsikkoa ei ole, tiedoston nimeksi voi tulla oletusarvo.