Kihagyás

Markdown alapok

Miért Markdown

WYSIWYG-nek hívjuk azt, amikor úgy szerkeszted a fájlt, hogy közben a végeredményt látod. Ennek az egyik legnagyobb hátránya akkor jelentkezik, amikor formázott szövegek közt kell oda-vissza lépkedned. Hányszor fordult elő, hogy be volt kapcsolva a félkövér/dőlt betűtípus, de te már egy új sorban elkezdtél gépelni, erre minden amit leírtál az formázott lett. Markdownban sokkal valószínűtlenebb, hogy ilyen előfordul, mert mindig látod milyen stílusnak mikor van vége.

A HTML-hez hasonló szintaxisa van, de ez sokkal jobban le van egyszerűsítve. Ez azt jelenti, hogy elég lesz nekünk csak a szöveges tartalomra, annak a helyes formázására koncentrálni. A webes megjelenést majd egy másik eszköz fogja megoldani.

Note

Nincs megtiltva az, hogy HTML-t használj a fájlban, sőt, ezt még ki is egészítheted a style attribútummal, ezzel is jobban személyre szabhatod a fájlt.

Markdown fájl: .md

Egy Markdown fájl létrehozásához elég egy *.md elnevezésű fájlt létrehoznod.

Alap szintaxis

A szintaxist 2 csoportra lehet bontani: teljes sorra és sor egy kis részére alkalmazódóra.

Egész sorra kiható elemeket mindig egy üres sorral kell elválasztani a többitől.

Fejlécek

Egy jól szervezett Markdown fájlnak a tartalmát fejlécek választják el. Ezek HTML-hez hasonlóan H1-től H6-ig terjednek, ahol H1 a legnagyobb. Általában egy darab H1-es fejléc szokott szerepelni egy dokumentumban, ami a dokumentum címét szokta viselni.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# H1

## H2

### H3

#### H4

##### H5

###### H6

Tönkre menne az aloldal, ha ide sima kódként lenne berakva a megjelenés. Szóval inkább néz körbe az oldalon.

Új sor

Néha nem akarsz új bekezdést kezdeni, de új sort viszont igen. Erre két megoldás van:

Simán új sorban kezded amit írsz.

Ennek az a hátránya, hogy lehet nincs támogatva, így egy sornak fogja tekinteni a program, ami HTML kódot generál belőle.

Használod a <br> HTML címkét

Ez sokkal hatásosabb, látványosabb. Az ilyeneket 1:1-ben átemeli a HTML kódba a fordító.

1
2
3
4
5
Ez az első sor
Ez a második

Ez az első sor<br>
Ez a második

Ez az első sor Ez a második

Ez az első sor
Ez a második

Bekezdés

Egy bekezdés egy sorból áll. Minden új bekezdést egy üres sorral kell elválasztani a többitől.

1
2
3
Ez az első bekezdés

Ez a második bekezdés

Ez az első bekezdés

Ez a második bekezdés

Szöveg kiemelés

Szerkesztőtől függ, de általában gyorsgombok támogatva vanna, így annyival kevesebb szintaxisra kell emlékezni. HTML-hez hasonlóan, ha valamira valamit alkalmazni akarunk, akkor azt körbe kell fogni valamivel. Gyorsgomb használatakor jelöljük ki a formázandó szöveget, majd meg fog jelenni az elején és a végén két jel. Ami ez a két jel között van, arra fog alkalmazódni a formázás.

Gyorsgomb Szintaxis Végeredmény
Ctrl+I *dőlt* dőlt
Ctrl+B **félkövér** félkövér
- ***dőltfélkövér*** dőltfélkövér

Idézés

Ha idézni szeretnél, akkor minden idézendő sort egy > jellel kell kezdened.

1
2
3
> Ez egy több soros
>
> idézet.

Ez egy több soros

idézet.

Note

Egy idézeten belül is lehet formálni a szöveget.

Lista készítés

Listából két fajta van: számozott és számozatlan.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
1. Ez
2. Egy
3. Számozott
    1. Lista
4. Amiben
5. Van
6. Beljebb kezdés

- Ez
- Egy
- Számozatlan
    - Lista
- Amiben
- Van
- Beljebb kezdés
  1. Ez
  2. Egy
  3. Számozott
    1. Lista
  4. Amiben
  5. Van
  6. Beljebb kezdés

Lista lista utánt nem szeret a program, így kell ide valamilyen elválasztó szöveg 😢.

  • Ez
  • Egy
  • Számozatlan
    • Lista
  • Amiben
  • Van
  • Beljebb kezdés

Danger

Indentálásnál 4 darab Space-t kell használni.

Note

Számozott és számozatlan listát lehet egymásba ágyazni.

Kód beillesztés

Kódot lehet teljes vagy részleges formában beilleszteni.

Ebben a mondatban van egy `function()` kód, ami nem fut le.
    <div>
        <span>Ez egy többsoros kód, amit beljebb kezdéssel érek el, hogy ne fusson le</span>
    </div>

Ebben a mondatban van egy function() kód, ami nem fut le.

<div>
    <span>Ez egy többsoros kód, amit beljebb kezdéssel érek el, hogy ne fusson le</span>
</div>

Linkek

Linkeket is sokféleképpen lehet beilleszteni.

Lehet egy szövegrésznek [a link](https://google.com).

Lehet hivatkozni is rá, pl. ha sok link van, sok helyen újra felhasználnád.

Ez egy [hivatkozás][id] egy linkre, amit valahol máshol definiálok.

...
[id]: https://google.com

Lehet egy szövegrésznek a link.

Lehet hivatkozni is rá, pl. ha sok link van, sok helyen újra felhasználnád.

Ez egy hivatkozás egy linkre, amit valahol máshol definiálok.

Képek

![Ide jön a kép neve, ha nem töltődne be](https://a-kép-elérési-útvonala.hu/kép.png "Ide pedig az a szöveg jön, amit egér rávitel során kell látni")

Ide jön a kép neve, ha nem töltődne be

További olvasmány

Ez csak egy gyors összefoglalója az alap Markdown szintaxisnak, ennél bővebb útmutatók találhatóak szertemenően az interneten.

Forrás: https://www.markdownguide.org/basic-syntax/

Kibővített szintaxis

Ha a fenti feature-ökön végignézünk, akkor az elég szegényes. Nem is volt a célja a nyelvnek, hogy újra feltalálja a kereket, de ettől függetlenül néhány dolog még mindig hiányzik a nyelvől, amit jó volna, ha tudna. Ennek az lett az eredménye, hogy ki lett egészítve a nyelv.

Az itt leírtak már nem biztos hogy mindenhol, ahol Markdownt használnak, működni fog. Lehet egy kicsit módosítani kell majd rajta, de a "nagyoknál" működik.

Táblázatok

1
2
3
4
| Valami | Más |
| ------ | --- |
| 1      | 2   |
| 3      | 4   |
Valami Más
1 2
3 4

Határolt kódblokk

Eddig beljebb kellett kezdeni minden sort, amiben kód volt és nem szerettük volna, hogy lefusson.

Most már elég lesz körbehatárolni azt.

1
2
3
4
5
```javascript
function add(a, b) {
    return a + b;
}
```
function add(a, b) {
    return a + b;
}

Emellett az első sornak a végén meg lehet adni, hogy milyen kódról van szó, így ha támogatva van a szintaxis felismerés, akkor már helyes színek mellett fog megjelenni a kód.

Lábjegyzet

1
2
3
Ez egy átvett szöveg, aminek a végén van egy lábjegyzet[^1]

[^1]: Link vagy valami.

Ez egy átvett szöveg, aminek a végén van egy lábjegyzet1

Definíciós lista

1
2
3
4
5
6
First Term
: This is the definition of the first term.

Second Term
: This is one definition of the second term.
: This is another definition of the second term.
First Term
This is the definition of the first term.
Second Term
This is one definition of the second term.
This is another definition of the second term.

Áthúzott szöveg

~~Ez át van húzva~~, ez már nem.

Ez át van húzva, ez már nem.

Feladat lista

1
2
3
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media
  • Write the press release
  • Update the website
  • Contact the media

Emoji

Unicode vagy shortcode használatával.

1
2
3
4
5
6
7
:apple:

:cheese:

:fontawesome-brands-facebook:

😍☺️👀✅➡️😕

🍎

🧀

😍☺️👀✅➡️😕

Note

Vegyük észre, hogy a shortcode-dal beillesztett :apple: vagy más emoji igazából egy kép, unicode karakter meg egy... nos... karakter. Ez akkor lehet igazán fontos, ha szöveget szeretnénk másolni.

Automatikus URL felismerés

Ha csak egy gyors linket szeretnél beilleszteni, akkor nem kell formázással törődnöd, elég csak a linket beilleszteni, amiből automatikusan kattintható változat lesz.

További olvasmány

Ez csak egy gyors összefoglalója a kibővített Markdown szintaxisnak, ennél bővebb útmutatók találhatóak szertemenően az interneten.


  1. Link vagy valami.