A Markdown 5 perc alatt
Valószínűleg már használtad a Markdownt anélkül, hogy tudtál volna róla. Írtál már **félkövér** szöveget egy Slack üzenetben? README fájlt GitHub-on? Formáztál Reddit bejegyzést? Ez mind Markdown volt.
A Markdown egy egyszerű módszer a sima szöveg formázására néhány karakter segítségével. Ahelyett, hogy eszköztárgombokra kattintanál félkövérhez, dőlthez, fejlécekhez és listákhoz, néhány karakterrel jelzed a kívánt formázást. 2004-ben John Gruber és Aaron Swartz hozta létre, és azóta a fejlesztők, írók és mindenki alapértelmezett formázási nyelvévé vált, aki szöveggel dolgozik a weben.
Miért jött létre a Markdown?
A Markdown előtt a webes szövegformázás HTML-írást jelentett. Egy szó félkövérré tételéhez a <strong>félkövér</strong> kódot kellett írni. Egy lista létrehozásához a <ul><li>elem</li></ul> szerkezet kellett. A HTML erőteljes, de terjengős és nyers formájában nehezen olvasható.
A Markdown megoldja ezt azzal, hogy ember által olvasható gyorsírást biztosít. A nyers szöveg könnyen olvasható még megjelenítés előtt is. A formázott kimenet tiszta és professzionális. Mindkét világ legjobbjait kapod: olvasható forrásszöveget és csiszolt kimenetet.
Tudtad? A Markdown tervezési filozófiája szerint a nyers szövegnek „közzétehetőnek kell lennie úgy, ahogy van, sima szövegként, anélkül, hogy úgy nézne ki, mintha tagekkel vagy formázási utasításokkal lenne megjelölve." Ezért a Markdown szintaxis olyan karaktereket használ, amelyek vizuálisan sugallják az általuk előállított formázást.
Az alapvető szintaxis
Íme minden, amit tudnod kell ahhoz, hogy produktívan használd a Markdownt.
Fejlécek
Kettőskereszt szimbólumokkal (#) hozhatsz létre fejléceket. Több kettőskereszt kisebb fejlécet jelent.
# 1. szintű fejléc (legnagyobb)
## 2. szintű fejléc
### 3. szintű fejléc
#### 4. szintű fejléc
Félkövér és dőlt
Csomagold a szöveget csillagokba vagy aláhúzásokba:
**félkövér szöveg**
*dőlt szöveg*
***félkövér és dőlt***
Listák
A rendezetlen listák kötőjelet, csillagot vagy plusz jelet használnak. A rendezett listák számokat.
- Első elem
- Második elem
- Harmadik elem
1. Első lépés
2. Második lépés
3. Harmadik lépés
Linkek
Szögletes zárójelbe a szöveg, kerek zárójelbe az URL:
[Kattints ide](https://example.com)
Képek
Mint a linkek, de felkiáltójellel az elején:
Idézetek
Nagyobb, mint szimbólummal:
> Ez egy idézet. Be lesz húzva és eltérően stílusozva.
Kód
Fordított aposztróf az inline kódhoz, háromszoros fordított aposztróf kódblokkhoz:
Használd a `print()` függvényt szöveg kiírásához.
Többsoros kódblokkokhoz használj háromszoros fordított aposztrófot opcionális nyelvjelölővel:
```python
def hello():
print("Hello, world!")
```
Vízszintes elválasztók
Három vagy több kötőjel, csillag vagy aláhúzás:
---
Táblázatok
Függőleges vonalakat és kötőjeleket használj:
| Név | Szerepkör | Helyszín |
| --- | --- | --- |
| Alice | Fejlesztő | Berlin |
| Bob | Designer | London |
Hol használják a Markdownt?
A Markdown mindenhol jelen van:
Szoftverfejlesztés
- GitHub, GitLab, Bitbucket: A README fájlok, issue-k, pull request-ek és dokumentációk mind Markdownban íródnak.
- Stack Overflow: A kérdések és válaszok Markdown formázást használnak.
- Kód dokumentáció: Sok dokumentáció-generátor (Docusaurus, MkDocs, Jekyll) Markdownt használ forrásformátumként.
Kommunikáció
- Slack: A Markdown egy részhalmazát támogatja üzenetformázáshoz.
- Discord: Markdown-t használ félkövérhez, dőlthöz, kódblokkhoz és egyebekhez.
- Reddit: A bejegyzések és hozzászólások Markdownnal vannak formázva.
Írás és kiadás
- Blogok: Sok statikus webhelygenerátor Markdown fájlokat használ tartalomforrásként.
- Könyvek: Egyes kiadói eszközök elfogadják a Markdown kéziratokat.
- Jegyzetek: Az Obsidian, Notion, Bear és Typora alkalmazások Markdown köré épülnek.
Dokumentáció
- Technikai dokumentumok: Az API dokumentáció, felhasználói útmutatók és wikih általában Markdownt használnak.
- Belső tudásbázisok: Sok csapat Markdown-alapú wikivel dolgozik.
Tipp A Markdownt most azonnal kipróbálhatod és gyakorolhatod ingyen a böngésződben: Írás Markdownban. Lásd a formázott kimenetet valós időben, ahogy gépelsz.
Markdown változatok
Egy fontos dolog: a Markdownnak különböző „ízei" vannak. Az alap szintaxis mindenhol azonos, de egyes platformok bővítményeket adnak hozzá:
| Változat | Extra funkciók | Használja |
|---|---|---|
| CommonMark | Szigorú specifikáció | Általános szabvány |
| GitHub Flavored Markdown (GFM) | Feladatlisták, táblázatok, áthúzás, automatikus linkelés | GitHub |
| MultiMarkdown | Lábjegyzetek, hivatkozások, metaadatok | Akadémiai írás |
| R Markdown | Beágyazott R kód, adatelemzés | Adattudomány |
A különbségek főleg speciális funkciókban vannak. Az alapok (fejlécek, félkövér, dőlt, listák, linkek, képek, kód) mindenhol ugyanúgy működnek.
Gyakori hibák
Üres sorok elfelejtése
A Markdown sok elem előtt és után üres sort igényel. A fejléc előtt üres sor szükséges. A listának előtte és utána is üres sor kell. Az üres sorok elfelejtése a megjelenítési problémák leggyakoribb forrása.
Inkonzisztens listajelölők
A -, * és + keverése ugyanazon listában váratlan megjelenítést okozhat. Válassz egyet és tartsd magad hozzá.
Szóközök a szimbólumok után
Egyes Markdown feldolgozók szóközt igényelnek a # után a fejléceknél és a - után a listáknál. Mindig tegyél szóközt, hogy biztonságban legyél.
# Helyes fejléc
#Helytelen fejléc
- Helyes listaelem
-Helytelen listaelem
Figyelmeztetés A Markdown nem támogat minden formázási igényt. Ha összetett elrendezésre, színes szövegre, precíz tipográfiára vagy nyomtatásra kész dokumentumra van szükséged, HTML-re, LaTeX-re vagy szövegszerkesztőre lehet szükséged. A Markdown a legjobb strukturált, szövegközpontú tartalomhoz.
Miért érdemes megtanulni a Markdownt?
A Markdown megtanulása öt percet vesz igénybe, és az idő múlásával órákat takarít meg. Ha egyszer megtanulod, képes leszel:
- Olyan dokumentációt írni, amely gyönyörűen jelenik meg GitHub-on
- Slack és Discord üzeneteket formázni anélkül, hogy megérinted az egeret
- Strukturált jegyzeteket készíteni, amelyek hordozhatók az alkalmazások között
- Blogbejegyzéseket és webes tartalmat létrehozni egyszerű szövegfájlokból
- Szöveges dokumentumokon együttműködni formátum-kompatibilitási problémák nélkül
A befektetés és a megtérülés aránya az egész technológiai világ egyik legjobbjának számít.
Kezdj el most Markdownban írni:
Ingyenes, a böngésződben működik, valós idejű előnézettel gépelés közben.