A Markdown egy "könnyen" írható, "könnyen" olvasható webes formátum, mely tipikusan böngészőben megjelenített szövegek vagy dokumentumok gyors szerkesztését teszi lehetővé. Az órák során használt jupyter keretrendszer Markdown formátumú celláiba legtöbször az adott programozási témával kapcsolatos feladatok leírása kerül. Ezen kívül ha a feladat szövege megköveteli, hogy szavakban fejezzük ki a program megírása során szerzett tapasztalatainkat, akkor ezeket a gondolatokat is Markdown formátumú cellákba kell leírni! Az alábbiakban tekintsük át a Markdown-formátum alapjait.
Egy teljes notebook vagy egy szövegrész címeit Markdownban a #-jellel jelöljük. Egy # a teljes notebook címét, két # egy fejezet címét, egyre több # pedig a dokumentum tagolásának egyre mélyebb szerkezeti egységeit jelöli.
Markdownban lehetőség van egyes szavak vagy szövegrészletek kiemelésére. Ha egy szövegrészt egy *-al veszünk körbe, akkor dőlt lesz, ha két *-t használunk, akkor vastagon szedetté válnak a betűk. Ha egy szövegrészt két ~~ jel közé teszünk, akkor az a rész áthúzásra kerül.
Ha - jellel kezdünk sorokat Markdown cellákban, akkor azt a Markdown-értelmező listába fogja rendezni:
Ha számokkal kedjük a sorokat, akkor számozott listát kapunk:
Markdown-ban |, illetve - karakterek segítségével írhatunk táblázatokat. Például így:
Név | Oszályzat |
---|---|
Pisti | 4 |
Géza | 3 |
Gizi | 5 |
A feladatok megírása során szükség lehet arra, hogy bizonyos kérdéseknek utánanézzünk az interneten. Ha egy hasznos leírást találunk valahol, akkor arra Markdown-ban a következőképpen hivatkozhatunk: link neve.
Ha az interneten vagy a dokumentum saját könyvtárstruktúrájában lévő képet akarunk Markdown típusú cellában megjeleníteni, azt pedig így tehetjük meg:
Néhány feladat értelmezésénél szükséges lehet a feladat megoldásához vezető matematikai formulák ismertetése. Ha Markdown-ban \$ \$ -jelek közé teszünk latex szintaxisú szöveget, akkor szép matematikai képleteket tudunk írni, például ilyeneket, hogy $\sin(\alpha+\beta)=\sin(\alpha)\cos(\beta)+\cos(\alpha)\sin(\beta)$. Ha egy képletet nagyon ki akarunk emelni a szövegből, akkor tegyük két \$ jel közé! $$E=mc^2.$$ Tekintsünk át néhány további képletformázással kapcsolatos példát:
Végül pedig egy mindenkit izgató kérdés:
$$\frac{1}{2}x+b_u\cdot x=?$$