Sissejuhatus hinnaklassi

Märgistamine

Markdown on teksti HTML-i teisendamise tööriist. Tänapäeval on sellest saanud kergete märgistuste kirjelduskeelte klassi faktiline sünonüüm. See kasutab lihtsa teksti vormindamise süntaksit. Markdowni idee oli muuta veebilehtede ja eriti ajaveebikirjete kirjutamine sama lihtsaks kui e-kirjade kirjutamine. 2017. aasta novembri ajal on eesmärk saavutatud ja nii Markdown kui ka selle tuletised Asciidoc, Asciidoctor ja Asciidoctor-pdf on laialdaselt kasutusel.

Markdown keskendub ainult tavalisele tekstile ja hoidub kõigist muudest HTML-is leiduvatest keerukustest. Seda on lihtne õppida, kuna seda hoitakse lihtsana, seega ka kiiremini, kuna kasutatakse minimaalseid tähemärke, mis toob kaasa ka väiksemad vea võimalused lõpuks. Markdowni redaktoris Stackedit kuvatud alusdokumendi leiate jooniselt 1. Vasakul küljel näete lähtekoodi ja paremal vastavat HTML-väljundit. Võite märgata, et pealkirjad on lihtsalt pealkirja hierarhiataseme järgi tähistatud numbriga #.

Teksti teisendamine

Lihttekst on konverteeritav XHTML-i (HTML) ja paljudeks muudeks vorminguteks, kasutades käsurea tööriistu nagu Markdown või Pandoc. Põhimõtteliselt loovad mõlemad tööriistad ainult HTML-fragmendid ja kirjutavad väljundi stdouti. HTML-väljundi kirjutamiseks antud faili pakub Pandoc lülitit “-o failinimi”. Nagu allpool näha, nimetatakse väljundfaili põhiliseks.HTML ja sisaldab HTML-fragmenti - kaks pealkirja ja lõiku.

$ pandoc -o basic.HTML põhiline.md $ cat basic.HTML 
Debiani pakettide loomise juhised
 
Eessõna
 Masina eest vastutamine tähendab nii riistvara kui ka tarkvara komponentide eest hoolitsemist. Nagu igapäevaelus on süsteemiadministraator, on palju parem installida tarkvara tarkvarapaketina, mitte hulga lähtefailidena. See vähendab süsteemi nõuetekohase hooldamise kulusid. $ 

Täieliku HTML-päisega eraldiseisvate HTML-dokumentide loomiseks aktsepteerib lüliti “-s” järgmist:

$ pandoc -o basic.HTML -s põhiline.md $ cat basic.HTML           
Debiani pakettide loomise juhised
 
Eessõna
 Masina eest vastutamine tähendab nii riistvara kui ka tarkvara komponentide eest hoolitsemist. Nagu igapäevaelus vaadeldakse süsteemiadministraatorina, on palju parem installida tarkvara tarkvarapaketina, mitte hulga lähtefailidena. See vähendab süsteemi nõuetekohase hooldamise kulusid.   

Sisu visuaalsest kuvast eraldi hoidmise eelis on see, et see ei aja teie saidi ilmet sassi. 1. versioon.0.1, mille on välja töötanud John Gruber ja Aaron Swartz, ilmus detsembris 2004 ja on saadaval tasuta tarkvarana (vt linke artikli lõpus).

Tekstielemendid

Pealkirjad

Vastavalt HTML-tasemele kirjutatakse pealkirjad arvudega # järgmiselt:

# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6 

H1 ja H2 puhul on lubatud kaks alternatiivset kirjutamisviisi:

H1 == H2 -- 

Pange tähele, et võrdusmärkide või kriipsude arv peab vastama pealkirja tähemärkide arvule.

Teksti rõhutamine

Teksti rõhutamiseks toetatakse neid elemente:

• kursiiv: üksikud tärnid või üksikud alakriipsud
  --
  * oluline * ja _ongi oluline_
  --
• rasvane tekst: topelttärnid või topeltjooned
  --
  ** oluline ** ja __tähtis__
  --
• kriipsutatud tekst: topelttilded
  --
  ~~ tekst ~~
  --

Loendid

Markdown toetab tellimata ja järjestatud loendeid. Järjestatud loendid algavad tärniga, pluss- või miinusmärgiga. Järjestatud loendid algavad lihtsalt numbriga. Alamloendite loomiseks taandage loendiüksust kahe tühiku (Markdown, StackEdit) või nelja tühiku (Pandoc) abil, nagu näete allpool:

1. puuviljad * õun * banaan 2. joogid + vesi + piim 

Kujutised

Lihtsaim viis on kasutada tekstisisest stiili järgmiselt:

![Debiani logo] (debiani logo.png “Debiani logo”) 

See kuvab viidatud pildi. Niipea kui liigutate hiirekursorit pildi kohal, näete vastavat kirjeldavat teksti.

Koodi ja süntaksi esiletõstmine

On kaks varianti - sisemine kood ja koodiplokid. Sissekood on raamitud kolmes tagurpidi nagu printimine („Tere, maailm!")" ". Koodiplokid algavad ja lõpevad ka kolme tagasilöögiga, kuid eraldi ridadel järgmiselt:

"print (" Tere, maailm!")"

Markdown ei toeta süntaksi esiletõstmist, kuid sellised dialektid nagu Markdown Here.

Tabelid

Markdown ei toeta tabeleid, kuid laiendusi nagu GFM ja Markdown Here teevad.

Blokeeritud pakkumised

Blokeeringupakkumised algavad lihtsalt märgiga “>”. Teksti tsiteerimine muutub üsna käepäraseks.

> "Oh! on absurdne, kui kehtib karm ja kiire reegel selle kohta, mida peaks> lugema ja mida mitte. Rohkem kui pool kaasaegsest kultuurist sõltub> sellest, mida ei tohiks lugeda.">> Teenimise tähtsus. (Oscar Wilde) 

Lingid

Lingid viitavad teistele dokumentidele või praeguse jaotistele. Kirjutamisstiil sarnaneb piltidega ja koosneb nurksulgudes lingi kirjeldusest ja tavalistes sulgudes olevast URL-ist.

[Olen tekstisisene link] (https: // linuxhint.com) 

Lisaks võite lisada alternatiivse teksti:

[Ma olen lisatekstiga tekstisisene link] (https: // linuxhint.com (LinuxHint)) 

Lingidele saab viidata järgmiselt:

[LinuxHint] [1] ... tekst ... [1]: https: // linuxhint.com 

See võimaldab teil oma dokumendi lõppu hõlpsasti koostada viidete loendeid, nagu see on tavaline teaduslikes dokumentides.

Järeldus

Markdown on üsna lihtne ja kohustuslik kõigile, kes dokumentatsiooni teevad ja regulaarselt sisu avaldavad. Selle kasutamine on suur rõõm.

Viited

• StackEdit, https: // stackedit.io / toimetaja
• Pandoc, http: // pandoc.org /
• Markdown, https: // julge tulekera.net / projektid / juurdehindlus /
• Markdown Cheatsheet, https: // github.com / adam-p / markdown-here / wiki / Markdown-Cheatsheet