A Markdown egy webes "könnyen" írható, "könnyen" olvasható formátum, mely tipikusan böngészőben megjelenített szövegek, 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 porgramozási feladattal 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 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 # jelölheti például 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.
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é veszünk, akkor az a rész áthúzásra kerül.
Markdown cellákban ha - jellel kezdünk sorokat, akkor azt a Markdown értelmező listába fogja rendezni:
Ha számokkal kedjük a sorokat, akkor számozott listát kapunk
Markdown-ban | és - karakterek segítségével meghatározott módon körbehatárolt szövegrészlet 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éges lehet bizonyos kérdéseknek utánanézni az interneten. Ha egy hasznos leírást találunk valahol, akkor arra Markdown-ban így link neve hivatkozhatunk.
Ha az interneten vagy a dokumentum saját könyvtárstruktúrájában lévő képet akarunk Markdown cellában mejelení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ük át néhány további képlet formázással kapcsolatos példát:
Végül pedig egy mindenkit izgató kérdés:
$$\frac{1}{2}x+b_u\cdot x=?$$