Markdown sintakses pamati un pielietojums dokumentācijā
Markdown ir viegla iezīmēšanas valoda, ko plaši izmanto strukturēta teksta veidošanai, neizmantojot sarežģītas vizuālās rediģēšanas saskarnes. Šī sintakse ļauj autoram koncentrēties uz saturu, izmantojot vienkāršus teksta simbolus, lai norādītu dokumenta elementu nozīmi un hierarhiju. Markdown tiek izmantots piezīmju, instrukciju, README failu un īsu rakstu sagatavošanai, kā arī tehnisko dokumentu izstrādē.
Dokumenta struktūru nosaka konkrēti sintakses elementi:
- Virsraksti: Tiek veidoti, izmantojot režģa simbolu
#pirms teksta. Virsrakstu līmeņi nosaka dokumenta hierarhiju. - Saraksti: Atbalsta gan numurētus, gan nenumurētus sarakstus, kā arī GitHub stila uzdevumu sarakstus (task lists) ar izvēles rūtiņām.
- Tabulas: Ļauj strukturēt datus rindās un kolonnās, izmantojot vertikālās svītras
|un defises-. - Koda bloki: Paredzēti programmēšanas koda vai termināļa komandu attēlošanai, saglabājot fiksēta platuma fontu.
- Citāti (blockquotes): Tiek izdalīti, izmantojot leņķiekavu
>rindas sākumā. - Saites un attēli: Ļauj integrēt klikšķināmas tīmekļa norādes un vizuālos materiālus tieši tekstā.
- Izcēlumi: Treknraksts un slīpraksts tiek definēti, izmantojot zvaigznītes
*vai apakšsvītras_.
Tiešsaistes priekšskatījums un redaktora funkcijas
Satura izstrādes procesā būtiska nozīme ir tūlītējai vizuālajai atgriezeniskajai saitei. Rīks nodrošina tiešsaistes priekšskatījumu, kas reāllaikā attēlo noformēto tekstu blakus redaktoram. Ja redaktors ir tukšs, priekšskatījuma apgabalā ir redzams teksts "Šeit parādīsies noformētais priekšskatījums.".
Lietotājam ir pieejamas vairākas saskarnes vadīklas darba vides pielāgošanai:
- Skatu pārslēgšana: Iespējams pārslēgties starp skatiem "Rakstīt" un "Priekšskatījums", lai optimizētu ekrāna vietu.
- Vizuālais režīms: Redaktoram var aktivizēt funkciju "Tumšais redaktors", kas atvieglo darbu vāja apgaismojuma apstākļos.
- Statistika: Redaktora apakšā tiek veikta reāllaika uzskaite, rādot rādītājus "Vārdi" un "Rakstzīmes".
- Notīrīšana: Noklikšķinot uz "Notīrīt", vārdu un rakstzīmju skaitītāji tiek atiestatīti uz nulli, priekšskatījuma laukā parādās noklusējuma teksts "Šeit parādīsies noformētais priekšskatījums.", un tiek parādīts statusa paziņojums "Redaktors ir notīrīts.".
Sākotnēji redaktorā kā paraugs tiek ielādēts šāds teksts:
# Sveiki
Rakstiet **Markdown** šeit un skatiet noformēto rezultātu labajā pusē.
Sistēmas gatavību darbam apliecina statusa paziņojums "Gatavs. Rakstiet vai ielīmējiet Markdown, lai redzētu tiešsaistes priekšskatījumu.".
PDF dokumentu ģenerēšana pārlūkprogrammā
Eksportēšana uz PDF formātu netiek veikta ārējā serverī; tā vietā tiek izmantots tīmekļa pārlūkprogrammas iebūvētais drukāšanas dzinējs. Kad lietotājs noklikšķina uz pogas "Eksportēt PDF", tiek izsaukts pārlūkprogrammas drukāšanas dialoglogs. Lai sekmīgi saglabātu dokumentu, lietotājam kā galamērķis manuāli jāizvēlas opcija "Saglabāt kā PDF". Pirms eksportēšanas ieteicams pārbaudīt priekšskatījumu, kā arī drukāšanas iestatījumos norādīt vēlamo lapas izmēru un malas.
Ja lietotājs mēģina eksportēt tukšu dokumentu, pārlūkprogrammas drukāšanas logs netiek atvērts. Tā vietā tiek parādīts kļūdas paziņojums "Vēl nav ko eksportēt — vispirms uzrakstiet Markdown tekstu.".
Eksportētā PDF faila nosaukums tiek noteikts automātiski. Sistēma meklē pirmo pirmā līmeņa virsrakstu (#) Markdown tekstā un izmanto to kā faila nosaukumu. Ja dokumentā nav neviena pirmā līmeņa virsraksta, failam tiek piešķirts noklusējuma nosaukums "Beznosaukuma dokuments".
Atlasāms teksts un saites eksportētajā PDF
Atšķirībā no vienkāršas ekrānuzņēmumu saglabāšanas vai dokumenta pārvēršanas plakanā attēlā, šis rīks ģenerē PDF failu ar saglabātu dokumenta struktūru. Tas nozīmē, ka visi teksta elementi eksportētajā PDF failā paliek pilnībā atlasāmi un meklējami. Lietotāji var kopēt tekstu tieši no PDF faila un izmantot meklēšanas funkciju (Ctrl+F vai Cmd+F), lai atrastu konkrētus vārdus.
Tāpat PDF dokumentā tiek saglabāta saišu funkcionalitāte. Jebkura Markdown tekstā definētā tīmekļa saite eksportētajā PDF failā būs aktīva un klikšķināma, ļaujot lasītājam pāriet uz norādīto interneta resursu tieši no dokumenta.
Lokālā apstrāde un datu privātums
Lietojot šo rīku, lietotāja ievadītais Markdown teksts netiek augšupielādēts BroBroGo serveros. Visa teksta apstrāde, parsēšana, vizuālā priekšskatījuma ģenerēšana un PDF eksportēšana tiek veikta lokāli lietotāja tīmekļa pārlūkprogrammā.
Šāda klientu puses (client-side) apstrāde nodrošina divas galvenās priekšrocības:
- Datu privātums: Tā kā dati nekad nepamet lietotāja ierīci un netiek sūtīti tīklā, tiek novērsta datu pārtveršanas vai uzglabāšanas iespēja ārējos serveros.
- Ātrdarbība: Apstrāde notiek acumirklī, jo nav nepieciešams gaidīt servera atbildi vai augšupielādēt un lejupielādēt failus.
Biežāk uzdotie jautājumi (FAQ)
Vai mans Markdown teksts tiek augšupielādēts?
Nē. Apstrāde, priekšskatījums un PDF eksportēšana notiek lokāli jūsu pārlūkprogrammā.
Kā es varu iegūt PDF failu?
Noklikšķiniet uz "Eksportēt PDF". Tiks atvērts pārlūkprogrammas drukāšanas logs — kā galamērķi izvēlieties "Saglabāt kā PDF".
Vai PDF teksts būs atlasāms?
Jā. Eksportēšanai tiek izmantots pārlūkprogrammas iebūvētais drukāšanas dzinējs, tāpēc PDF failā tiek saglabāts reāls, meklējams teksts un strādājošas saites, nevis plakans attēls.
Kādas Markdown funkcijas tiek atbalstītas?
Virsraksti, saraksti, tabulas, koda bloki, citāti, saites, attēli, izcēlumi un GitHub stila uzdevumu saraksti.
Kāds būs mana eksportētā PDF faila nosaukums?
PDF izmanto pirmo # virsrakstu jūsu Markdown failā kā nosaukumu un ieteicamo faila nosaukumu. Ja jūsu Markdown failā nav galvenā līmeņa virsraksta, tas tiek eksportēts kā “Dokuments bez nosaukuma”.