I ♥ Markdown
A Markdown jelölőnyelv tökéletes eszköz különféle dokumentációk írásához: pehelysúlyú, sokoldalú, könnyen tanulható. Az idődet a formázások helyett az írásra fordíthatod.
Egy jó dokumentáció megírásával a későbbiekben sok időt spórolhatunk. Különösképpen ha az elkészült dokumentációt egy webszerveren keresztül osztjuk meg. Ilyen esetben a legtöbben HTML-t használunk, amit egyszerűbb esetben egy fapados szövegszerkesztővel kalapálunk össze. Nem rossz, de a Markdown jobb.
A Markdown inkább író, mint publikációs eszköz, ami szöveges webcikkek megíráshoz lett tervezve. A Markdown fájlok úgy lettek tervezve, hogy könnyen olvashatók legyenek, minimálisan zavaró, de olyan címkékkel, amik természetesen illeszkednek a szövegbe. Az idézetek idézeteknek néznek ki, a listák listáknak, és azt hiszem sokan használják a *csillagozást* a hangsúlyozáshoz.
A kedvencem a Markdown speciális karakter kezelése: ilyen nem létezik. Nem kell törődnöd a speciális HTML karakterkódokkal (pl különféle zárójelek, reláció jelek kódjai), amik csak azért vannak, hogy nehezebb legyen. Az meg főleg rémálom, ha pl HTML-oktató anyagot kell megírni HTML-ben.
Ha a Markdownban nincs olyan HTML formázás, amit szeretnél, akkor semmi vész, nyugodtan használhatsz HTML címkéket is a Markdown dokumentumban.
Markdown gyorstalpaló
Például itt van ez az egyszerű kis dokumentum:
## Ez meg egy H2 címsor
### H3... érted? És ez így meg egészen H6-ig.
A bekezdések is tök egyszerűek. Csak kezdj el gépelni és ha vége a bekezdésnek, hagyj egy üres sort.
Kik használnak Markdownt? Tanulók, tanárok, tudósok, GitHub, Stackoverflow, Drupal, Wordpress, Doxygen, stb. Ezeken kívül sok programnyelv is támogatja, pl a Python, a Perl, a JavaScript, a Haskell, az Awk, a C. a C++, és így tovább.
>
>> Ha durvulni akarsz, akkor tehetsz az idézetbe is idézetet
>
> Aztán visszatérhetsz az előző szinthez.
> Létrehozhatsz többsoros idézeteket egyetlen kacsacsőrrel, annyi szöveget írhatsz mögé, amennyit csak akarsz.
> Vagy használhatsz kézi sortörést
> de akkor minden sort kacsacsőrrel
> kell kezdened a Markdown fájlban.
> Ez nem befolyásolja a HTML konverziót.
Felsorolásokat olyan könnyű létrehozni, hogy az ember szinte sír a boldogságtól. A felsorolásokhoz kötőjeleket, plusz jeleket és csillagokat használhatunk. HTML konverzió után ezekből szép pöttyök lesznek, nem érdekes, hogy melyiket használtad:
- is keverheted
+ őket
A sorszámozott listák sorainak elejére sorszámokat kell írni és egy pontot:
2. Ez meglőtte
3. Ez hazavitte
4. Ez megsütötte
5. Ez mind megette
Képeket így lehet beszúrni a szövegbe:
Linkeket pl ilyen egyszerű létrehozni:
Ha szavakat *csillagok* közé írod, akkor abból dőlt lesz, ha **dupla csillag** közé akkor vastag lesz. De a legjobb a Markdownban az, hogy nem kell szórakozni a HTML címke párokkal. Csak egyszer kell megjelölni és már mehetsz is tovább. A bekezdéseket például nem is különösebben jelölni.
Teszt!
Ha ki szeretnéd próbálni az eddigieket, akkor csak másold be a fenti kódrészleteket egy sima szövegszerkesztőbe és mentsd el pl "teszt.md" néven. Ha megvagy, akkor pl Pythonban így konvertálhatod HTML-be:
Nyisd meg a "teszt.html" fájlt és lásd! Az eredmény egy szépen formázott weboldal.
Drupal
Régebben még HTML-ben írtam erre az oldalra a posztokat, de egy jó ideje már áttértem a Markdownra. Ehhez két modult használok:
Na jó, hármat. Egy kis konfigurálás, jogosultságok, stb és már kész is.
Az eredmény pedig egy nagyon kezes szövegszerkesztő.
További infók
Rengeteg infó van pl. a a fejlesztő oldalán és a Wikipédián is.