A Markdown egyszerű módja a szöveg formázásának egyszerű karakterek segítségével. Mindenütt jelen van — GitHubon, Redditen, Notionban, Discordon, műszaki dokumentációban és számtalan más platformon. Ahelyett, hogy gombokra kattintanál, hogy félkövérré tegyél szöveget vagy fejléceket hozz létre, egyszerű szimbólumokat írsz. Ez az útmutató megtanítja az alapokat, és az ingyenes Markdown Előnézet eszközzel gyakorolhatod is.
Amire szükséged van
- Webböngésző (Chrome, Firefox, Safari vagy Edge)
- Nincs szükség fiókra vagy telepítésre
- Körülbelül 10 perc az alapok megtanulásához
Lépésről lépésre útmutató
Nyisd meg a Markdown Előnézet eszközt
Menj a Markdown Előnézet eszközhöz. Egy osztott képernyős szerkesztőt fogsz látni: a bal oldalon írod a Markdownt, a jobb oldalon valós időben látható a formázott előnézet. Minden begépelt változás azonnal megjelenik az előnézetben.
Tanuld meg az alapvető szintaxist
Kezdj el gépelni a szerkesztőbe, hogy kísérletezz a Markdown formázással. Az alapvető szintaxis egyszerű, és percek alatt elsajátítható. Gyakorolj az alábbi példákkal — gépeld be őket a bal oldalon, és nézd meg a formázott eredményt a jobb oldalon.
Írd meg a dokumentumodat
Most írd meg a tényleges tartalmad. Használj fejléceket a dokumentum strukturálásához, listákat az információk rendezéséhez, és félkövér vagy dőlt szöveget a hangsúlyozáshoz. A valós idejű előnézet biztosítja, hogy mindig tudd, hogyan néz ki a végeredmény gépelés közben.
Exportálás vagy másolás
Ha a dokumentum úgy néz ki, ahogy szeretnéd, másold a Markdown szöveget bármely platformra, amely támogatja, vagy exportáld a formázott eredményt. A Markdown tartalom beilleszthető GitHubra, Redditen, Notionba vagy bármilyen Markdown-kompatibilis szerkesztőbe.
Hasznos tudnivaló A Markdownt úgy tervezték, hogy renderelés nélkül is olvasható legyen. Egy Markdown dokumentum egyszerű szövegként is letisztultnak és strukturáltnak tűnik, részben ez az egyik oka, hogy ilyen népszerűvé vált.
Alapvető Markdown szintaxis
Fejlécek
Fejlécek létrehozásához használj # szimbólumokat. Több # szimbólum kisebb fejlécet jelent:
# 1. fejléc (legnagyobb)
## 2. fejléc
### 3. fejléc
#### 4. fejléc
Félkövér és dőlt szöveg
Csillagokba zárj szöveget a kiemeléshez:
**Ez félkövér szöveg**
*Ez dőlt szöveg*
***Ez félkövér és dőlt***
Listák
Rendezetlen listákat kötőjelekkel, rendezett listákat számokkal hozz létre:
- Első elem
- Második elem
- Harmadik elem
1. Első lépés
2. Második lépés
3. Harmadik lépés
Linkek
Kattintható linkeket szögletes zárójelekkel és kerek zárójelekkel hozz létre:
[Link szöveg](https://pelda.hu)
Kód
Fordított aposztrófot használj soron belüli kódhoz, hármas fordított aposztrófot kódblokkhoz:
Soron belüli: `console.log("hello")`
Kódtömb:
```javascript
function udvozles(nev) {
return "Helló, " + nev;
}
```
Tipp Nem kell mindent egyszerre megjegyezni. Kezdj a fejlécekkel, félkövér szöveggel és listákkal — ez a három a tipikus Markdown írás 80%-át lefedi. Adj hozzá több szintaxist, ahogy szükséged van rá.
Képek
Adj hozzá képeket a link szintaxis elé tett felkiáltójellel:
Idézetek
Használd a > karaktert idézett szöveg létrehozásához:
> Ez egy idézet.
> Több sort is átfoghat.
Hol használják a Markdownt?
| Platform | Hogyan használják a Markdownt |
|---|---|
| GitHub | README fájlok, issue-k, pull request-ek, megjegyzések |
| Bejegyzés és hozzászólás formázás | |
| Notion | Oldaltartalom és dokumentáció |
| Discord | Üzenetformázás |
| Stack Overflow | Kérdések, válaszok és megjegyzések |
| Statikus weboldal generátorok | Blogbejegyzések és oldalak tartalma |
Fontos A különböző platformok enyhén eltérő Markdown funkciókat támogatnak. Az alapok (fejlécek, félkövér, dőlt, listák, linkek) mindenhol működnek. A haladó funkciók, mint a táblázatok vagy lábjegyzetek, platformonként eltérnek. Mindig tekintsd meg az előnézetet, mielőtt közzéteszel egy új platformon.
Gyakran ismételt kérdések
Mi a különbség a Markdown és a HTML között? A Markdown a háttérben HTML-lé konvertálódik. Egyszerűbb módja a formázott szöveg írásának HTML tagek megjegyzése nélkül. Bárhol, ahol a Markdown elfogadott, HTML-ként rendereli.
Használhatom a Markdownt professzionális dokumentumokhoz? Természetesen. Sok csapat a Markdownt használja dokumentációhoz, javaslatokhoz és jelentésekhez. Léteznek eszközök a Markdown PDF, Word és prezentációs formátumokba való konvertálásához.
Ugyanaz a szintaxis mindenütt? Az alapvető szintaxis univerzális. Egyes platformok bővítményeket adnak hozzá (mint a GitHub Flavored Markdown, amely táblázatokat és feladatlistákat ad hozzá). Az ebben az útmutatóban tárgyalt alapok mindenhol működnek.
Következő lépések
Most, hogy ismered a Markdownt, próbálj írni egy README-t egy projekthez, formázni egy blogbejegyzést, vagy műszaki dokumentációt létrehozni. Haladóbb formázási feladatokhoz fedezd fel a JSON Formázót kód dokumentációhoz, vagy a PDF Szerkesztőt a végső dokumentum kimenetéhez.