A markdown egy olyan jól olvasható jelölőnyelv, amely egyszerű ASCII karakterekkel jelzi többek között a kiemelt, félkövér vagy áthúzott szöveget, a címeket vagy hiperhivatkozásokat.
Ezen az oldalon való kérdések és válaszok megírásához egész nyugodtan használható a grafikus eszköztár a szerkesztőablak tetején, azonban a szövegdoboz az általánosan megszokott, ún. WYSIWYG szerkesztőktől eltérően továbbra is csak egyszerű szöveget fog tartalmazni a kiegészített markdown karakterekkel — az publikálás utáni eredmény viszont a szerkesztőablak alatt már élesben is nyomon követhető.
Egy-két fontosabb eszköz és tipp a markdown használatához:
- A sortörés önmagában nem jelent új bekezdést, hagyj ki egy üres sort a logikai egységek között!
- A kiemelni kívánt szövegeket zárjuk * karakterek közé, a félkövér jelöléshez használjuk azokat duplán. Egyes markdown nyelvjárások az áthúzott szöveget a tilde karakterrel jelzik:
1 |
Ebben a mondatban van *fontos*, **nagyon fontos** és ~~már egyáltalán nem fontos~~ szöveg is. |
- A cím jelölhető a sor eleji # karakterrel vagy karakterekkel, amelyek száma a cím súlyát adják meg, vagy aláhúzható - vagy = karakterekkel:
1 2 3 4 5 6 7 8 9 |
# Főcím ## Alcím Főcím ===== Nem annyira fontos cím ---------------------- |
- A felsoroláshoz a sort indítsuk csillaggal, számozott listákhoz pontokkal követett számokkal:
1 2 3 4 5 |
* foo * bar 1. foo 2. bar |
- A programkódot a könnyebb olvashatóság érdekében mindig jelöljük: a folyószövegben ún. backtick (Alt+7) karakterek között, míg a nagyobb kódrészleteket különálló bekezdésben, de minden sor elején 4 szóköz karakterrel indítva:
1 2 3 4 |
Az inline kód `így` jelölendő, míg a hosszabb R kódokat külön logikai egységbe rakjuk: l <- sample(0:1, 1) ifelse(l == 0, '5 forint', '-23 forint') |
További információ: wiki, original docs, Pandoc