Markdown on laialdaselt kasutatav märgistuskeel, mis võimaldab luua lihtsa tekstivormingu abil struktureeritud ja visuaalselt vormindatud dokumente. Tööriist "Markdown PDF-iks" pakub võimalust kirjutada või kleepida Markdown-teksti otse veebibrauseris, näha reaalajas selle kujundatud eelvaadet ning eksportida tulemus PDF-failina. Kogu protsess toimub täielikult kasutaja seadmes, tagades andmete privaatsuse ja kiire töötluse.
Markdowni süntaks ja dokumendi struktuur
Markdowni kasutatakse laialdaselt tehnilises dokumentatsioonis, märkmete tegemisel, juhiste koostamisel ja artiklite mustandite kirjutamisel. Selle keele eeliseks on loetavus ka puhta tekstina, ilma et vorminduskoodid sisu häiriksid. Hästi vormindatud dokumendi struktuur põhineb selgel hierarhial, mida esitatakse erinevate elementide abil:
- Pealkirjad: Pealkirjade tasemeid määratakse trellide (
#) arvuga rea alguses. Esimene kõrgeima taseme pealkiri (#) määrab dokumendi põhiteema. - Loendid ja ülesannete nimekirjad: Toetatud on nii nummerdatud kui ka punktloendid. Lisaks toetab tööriist GitHubi stiilis ülesannete loendeid (task lists), mis võimaldavad märkida tegevusi tehtuks või tegemata kujul.
- Tabelid ja koodiplokid: Andmete struktureerimiseks saab kasutada tabeleid ning tehnilise sisu esitamiseks koodiplokke, mis säilitavad programmeerimiskeelte spetsiifilise taande ja kirja.
- Tsitaadid, lingid ja pildid: Teksti sisse saab lisada plokk-tsitaate (blockquotes), hüperlinke teistele veebiressurssidele ning viiteid piltidele.
- Rõhutused: Teksti saab muuta paksuks või kaldkirjaks, kasutades tärne või allkriipse.
Tööriista käivitamisel kuvatakse redaktoris näidistekst: `# Tere
Kirjutage siia Markdown-tekst ja näete selle vormindust paremal.`.
Reaalajas eelvaade ja redaktori funktsioonid
Tööriist sisaldab reaalajas eelvaate (live preview) funktsiooni, mis teisendab sisestatud Markdown-teksti koheselt visuaalselt kujundatud vormingusse. Kasutajaliides võimaldab lülituda kahe vaate vahel: "Kirjuta" vaade teksti sisestamiseks ja redigeerimiseks ning "Eelvaade" vaade lõpptulemuse kontrollimiseks. Redaktori kasutamise mugavuse tagamiseks on olemas ka "Tume redaktor" režiim, mis vähendab silmade väsimust hämaras töötamisel.
Redaktori allosas kuvatakse reaalajas statistikat sisestatud teksti kohta:
- Sõnu: näitab dokumendis olevate sõnade koguarvu.
- Märke: kuvatakse märkide arv koos tühikutega.
Kui kasutaja sisestab teksti, kuvatakse olekuribal teade: "Valmis. Otseedastusega eelvaate nägemiseks kirjutage või kleepige Markdown-tekst.". Nupu "Tühjenda" vajutamisel kustutatakse kogu redaktori sisu. Selle toimingu järel lähtestatakse sõnade ja märkide loendurid nulliks, eelvaate alal kuvatakse tekst "Teie vormindatud eelvaade ilmub siia." ning olekureale ilmub teade "Redaktor on tühjendatud.".
PDF-failide genereerimine brauseris
Erinevalt traditsioonilistest konverteritest, mis saadavad failid töötlemiseks välisesse serverisse, kasutab see tööriist PDF-i genereerimiseks täielikult veebibrauseri kohalikku prindimootorit. Kui kasutaja klõpsab nupule "Ekspordi PDF-ina", avaneb brauseri süsteemne prindidialoog. Kasutaja peab sihtkohaks (destination) käsitsi valima "Salvesta PDF-ina" (Save as PDF). Prindiseadetes saab täiendavalt määrata lehe suuruse, orientatsiooni ja veerised.
Kuna eksportimisel rakendatakse brauseri prindimootorit, ei muudeta dokumenti pildiks. Eksporditud PDF-fail sisaldab reaalset, otsitavat ja märgistatavat teksti ning kõik dokumendis olevad lingid jäävad toimivaks ja klikitavaks.
Kui redaktor on tühi ja kasutaja üritab dokumenti eksportida, siis prindidialoogi ei avata ning kuvatakse veateade: "Pole midagi eksportida – kirjutage esmalt veidi Markdown-teksti.".
Eksporditava faili nime määramisel kehtib kindel reegel: PDF kasutab pealkirjana ja soovitatud failinimena Markdowni esimest #-pealkirja. Kui dokumendis puudub kõrgeima taseme pealkiri, määratakse faili nimeks "Nimetu dokument".
Privaatsus ja kohalik andmetöötlus
Tööriista arhitektuur põhineb täielikult kliendipoolsel (client-side) töötlemisel. Teie Markdowni töödeldakse teie brauseris ning midagi ei laadita BroBroGo serverisse. Teksti parsimine, eelvaate genereerimine ja PDF-i eksportimiseks ettevalmistamine toimuvad lokaalselt kasutaja seadmes. See tagab andmete privaatsuse, kuna tundlikud märkmed, dokumendid või isiklikud tekstid ei liigu üle võrgu kolmandate osapoolte serveritesse. Samuti tagab kohalik töötlemine viivitusteta toimimise, kuna puudub vajadus failide üles- ja allalaadimiseks.
Korduma kippuvad küsimused
Kas minu Markdown laaditakse serverisse?
Ei. Parser, eelvaade ja PDF-i eksport töötavad täielikult kohapeal teie brauseris.
Kuidas ma saan PDF-faili?
Klõpsake "Ekspordi PDF-ina". Avaneb teie brauseri prindidialoog – valige sihtkohaks "Salvesta PDF-ina".
Kas PDF-i teksti saab märgistada ja kopeerida?
Jah. Eksportimisel kasutatakse teie brauseri kohalikku prindimootorit, seega säilib PDF-is reaalne otsitav tekst ja toimivad lingid, mitte lame pilt.
Milliseid Markdowni funktsioone toetatakse?
Pealkirjad, loendid, tabelid, koodiplokid, tsitaadid, lingid, pildid, rõhutused ja GitHubi stiilis ülesannete loendid.
Mis saab olema minu eksporditud PDF-i pealkiri?
PDF kasutab pealkirjana ja soovitatud failinimena teie Markdowni esimest #-pealkirja. Kui teie Markdownil pole kõrgeima taseme pealkirja, eksporditakse see nimega "Pealkirjata dokument".