A Markdown alapjai

Mi a Markdown?

A Markdown egy speciális szintaktikai elemekből felépített szövegfájl alapú dokumentum. Kiterjesztései általában *.md ( *.markdown ) Használatával egy egyszerű text fájl szerkesztésével, melyben néhány vezérlő karaktert helyezünk el "akadémiai" megjelenésű dokumentum állítható elő...

Hol használják?

Használata egyre terjed. A legnépszerűbb projekt megosztó rendszeren (kb. 30 millió fejlesztő használja) a projektek leírását, rövid ismertetőjét egy ilyen fájlban kell elkészíteni. (README.md)

Javasolt a saját programokhoz készített dokumentációk, jegyzetek elkészítése is ebben a formában, mivel kevés ismerettel szép kivitelű dokumentumok készíthetők így rövid idő alatt.

Programozók számára a Markdown különösen jó eszköz, mivel a dokumentumban elhelyezhetünk forráskód részleteket, melyek programnyelv függő színezése is megoldott.

Mivel készítsük a Markdown dokumentumokat?

Bármilyen, akár a legegyszerűbb szövegszerkesztővel is készíthetők: Notepad, Notepad++, Brackets, Visual Studio Code... Az Internetes közösségek által most a legjobbnak tartott (én is ezt használom) ingyenes több platformos program a Typora https://typora.io/, mivel a beírt formázási kódok eredményét azonnal mutatja.

Markdown szintaktikai elemek

#0 - Tartalomjegyzék készítése

[toc]

#1 - Címsorok

xxxxxxxxxx
# 1. szintű címsor  (vízszintes vonal is lesz alatta)
## 2. szintű címsor (vízszintes vonal is lesz alatta)
### 3. szintű...
#### 4. szintű...
##### 5. szintű...
###### 6. szintű címsor

#2 - Karakterformázás

xxxxxxxxxx
Félkövér szöveg előállítása * karakterekkel: **félkövér** szöveg.
Félkövér szöveg előállítása _ karakterekkel: __félkövér__ szöveg.
Dőlt betűs szöveg előállítása * karakterekkel: *dőlt betűs* szöveg.
Dőlt betűs szöveg előállítása _ karakterekkel: _dőlt betűs_ szöveg.
Áthúzott szöveg előállítása ~ (tilde) karakterekkel: ~~áthúzott~~ szöveg.

Félkövér szöveg előállítása * karakterekkel: félkövér szöveg. Félkövér szöveg előállítása _ karakterekkel: félkövér szöveg. Dőlt betűs szöveg előállítása * karakterekkel: dőlt betűs szöveg. Dőlt betűs szöveg előállítása _ karakterekkel: dőlt betűs szöveg. Áthúzott szöveg előállítása ~ (tilde) karakterekkel: áthúzott szöveg.

#3 - Listák készítése

​x
Számozott lista
​
1. Első...
2. Második...
3. Harmadik listaelem

1. Első...
2. Második...
3. Harmadik listaelem

xxxxxxxxxx
Felsorolás
​
- Első...
- Második...
- Harmadik listaelem
A - helyett * vagy + jel is használható...

• Első...
• Második...
• Harmadik listaelem

xxxxxxxxxx
Többszintű lista
​
- Első szint...      (kötőjel + szóköz + szöveg )
  - Második szint... (két szóköz + kötőjel + szóköz + szöveg)
  - Második szint... (két szóköz + kötőjel + szóköz + szöveg)
- Első szint...
  1. Második szint...
  2. Második szint...

• Első szint...

  • Második szint...
  • Második szint...

• Első szint...

  1. Második szint...
  2. Második szint...

#4 - Linkek használata

xxxxxxxxxx
A < > jelek között megadott link látható és kattintható - <https://edolg.com> 
​
Inline-stílus: csak a szöveg látszik és kattintható - [Dolgozatírás](https://edolg.com)
​
...

A < > jelek között megadott link látható és kattintható - https://edolg.com

Inline-stílus: csak a szöveg látszik és kattintható - Dolgozatírás

#5 - Képek beillesztése

xxxxxxxxxx
![](D2user.jpg)
​
![](https://edolg.com/img/edolg-com.png)

#6 - Forráskód beillesztése

xxxxxxxxxx
Inline `kódrészlet` beillesztéséhez az <AltGr-7> back-tick karakter használható.

Inline kódrészlet beillesztése: az back-tick karakterek közé írt szöveg kódrészlet típusú lesz...

xxxxxxxxxx
Többsoros kódblokkokat így illeszthetünk be
​
```C#
/* egy kis megjegyzés */
int counter = 0;
counter++;
```
​
```javascript
var szamlalo = 100; // innen indul
szamlalo++;
```
​
```bash
$ ls -al
```
​
Amennyiben nincs meghatározva a nyelv, nem lesz színezve a kód...

xxxxxxxxxx
/* c# kód */
int counter = 0;
counter++;

xxxxxxxxxx
// javascript kód
var szamlalo = 100;
szamlalo++;

xxxxxxxxxx
# bash kód
$ ls -al

#7 - Táblázatok előállítása

xxxxxxxxxx
Igazítás nélkül
​
| Kód | Név | fizetés |<Enter>
| --- | --- | --- |
| D01 | Gipsz Jakab | 300.000 |
​
A fejléc beírása után <Enter>-t ütve Typora-ban már legyártja a táblázatot...

xxxxxxxxxx
Igazítással...
​
| Kód | Név | Fizetés |<Enter>
| :--- | :---: | ---: |
| D01 | Gipsz Jakab | 300.000 |
| D02 | Csíkszentmihályi Mihály | 1.222.000 |

#8 - Blokk jelzés/behúzás alkalmazása

Hasonló megjelenés érhető el ezzel, mint mikor egy beérkezett e-mail-re választ írunk.

xxxxxxxxxx
> Ez a szövegrész
egy kissé beljebb
kezdődik majd...
​
Ez pedig már egy normál pozícióbal lévő szöveg...
(A behúzás kikapcsolásához egy üres sor beillesztése szükséges)

Ez a szövegrész egy kissé beljebb kezdődik majd...

Ez pedig már egy normál pozícióbal lévő szöveg...

#9 - Vízszintes elválasztó vonal beszúrása

xxxxxxxxxx
Kötőjelekkel
​
---
Csillag karakterekkel
​
***
Aláhúzás jelekkel
​
___
​

Kötőjelekkel

Csillag karakterekkel

Aláhúzás jelekkel

#10 - Feladatlista készítése

xxxxxxxxxx
- [x] A HTML elsajátítása...
- [ ] CSS használat megismerése...
- [ ] Komplex weboldal készítése... (HTML+CSS)

• A HTML elsajátítása...

• CSS használat megismerése...

• Komplex weboldal készítése... (HTML+CSS)

| Készítette: Katona József |