Markdown märgendite ülevaateleht

Markdown on lihtne ja laialt levinud märgenduskeel, mida kasutatakse teksti vormindamiseks, näiteks GitHubis. See loodi eesmärgiga olla kergesti loetav ja kirjutatav, võimaldades samal ajal teisendamist HTML-i ja teistesse vormingutesse. Siin kasutadud Hugo framework siiski kõiki märgendusi hästi ei toeta. LaTeXi märegnduse sain läbi häda käima, otse ta ei olnud nõus toimima. Samas GitHub toimetab temaga hästi. Käesolev ülevaateleht tutvustab kõiki peamisi Markdown märgendeid koos näidetega, eesmärgiga neid Hugo kasutamiseks ära kasutada.

Sisukord

Pealkirjad

Markdown-is saab luua kuut erinevat taseme pealkirja, kasutades numbrile vastavat arvu trellimärke (#).

# Pealkiri 1
## Pealkiri 2
### Pealkiri 3
#### Pealkiri 4
##### Pealkiri 5
###### Pealkiri 6

Tulemus:

Pealkiri 1

Pealkiri 2

Pealkiri 3

Pealkiri 4

Pealkiri 5

Pealkiri 6

Alternatiivne süntaks esimese ja teise taseme pealkirjade jaoks:

Pealkiri 1
=========

Pealkiri 2
---------

Tekstistiilid

Rõhutatud tekst (kaldkiri)

*See tekst on kaldkirjas*
_See tekst on samuti kaldkirjas_

Tulemus: See tekst on kaldkirjas See tekst on samuti kaldkirjas

Tugev rõhutus (paks kiri)

**See tekst on paksus kirjas**
__See tekst on samuti paksus kirjas__

Tulemus: See tekst on paksus kirjas See tekst on samuti paksus kirjas

Kombineeritud rõhutus

**See tekst on _väga_ tähtis**
*See tekst on **samuti** tähtis*

Tulemus: See tekst on väga tähtis See tekst on samuti tähtis

Läbikriipsutatud tekst

~~See tekst on läbikriipsutatud~~

Tulemus: ~~See tekst on läbikriipsutatud~~

Lõigud ja reavahetused

Markdown-is eraldatakse lõigud tühja reaga:

See on esimene lõik.

See on teine lõik.

Tulemus:

See on esimene lõik.

See on teine lõik.

Reavahetuse (uue rea) jaoks lisa rea lõppu kaks tühikut või kasuta HTML-i <br> elementi:

See on esimene rida.  
See on teine rida.

Või kasuta <br> elementi.
See on uus rida.

Tulemus:

See on esimene rida.
See on teine rida.

Või kasuta
elementi. See on uus rida.

Loendid

Nummerdatud loendid

1. Esimene element
2. Teine element
3. Kolmas element
   1. Taandega element
   2. Teine taandega element
4. Neljas element

Tulemus:

Esimene element
Teine element
Kolmas element
1. Taandega element
2. Teine taandega element
Neljas element

Markdown genereerib numbrid automaatselt, seega võid kasutada ka sama numbrit igal real:

1. Esimene element
1. Teine element
1. Kolmas element

Nummerdamata loendid

- Esimene element
- Teine element
- Kolmas element
  - Taandega element
  - Teine taandega element
- Neljas element

Tulemus:

Esimene element
Teine element
Kolmas element
- Taandega element
- Teine taandega element
Neljas element

Nummerdamata loendite jaoks võid kasutada -, *, või + märke:

* Esimene element
* Teine element

+ Esimene element
+ Teine element

Segatud loendid

1. Esimene nummerdatud element
   - Taandega nummerdamata element
   - Teine taandega nummerdamata element
2. Teine nummerdatud element

Tulemus:

Esimene nummerdatud element
- Taandega nummerdamata element
- Teine taandega nummerdamata element
Teine nummerdatud element

Lingid

Tavaline link

[Markdowni juhend](https://www.markdownguide.org)

Tulemus: Markdowni juhend

Pealkirjaga link (hiirega üle liikudes kuvatakse pealkiri)

[Markdowni juhend](https://www.markdownguide.org "Parim Markdowni ressurss")

Tulemus: Markdowni juhend

URL-id ja e-posti aadressid

<https://www.markdownguide.org>
<kasutaja@näide.com>

Tulemus: https://www.markdownguide.org <kasutaja@näide.com>

Viitelingid

[Markdowni juhend][1]
[Teine link][teine]

[1]: https://www.markdownguide.org
[teine]: https://www.example.com "Näite veebileht"

Tulemus: Markdowni juhend Teine link

Dokumendisisesed lingid

[Mine pealkirjade juurde](#pealkirjad)

Tulemus: Mine pealkirjade juurde

Pildid

Tavaline pilt

![Markdown Logo](https://markdown-here.com/img/icon256.png)

Tulemus: Markdown Logo

Pealkirjaga pilt

![Markdown Logo](https://markdown-here.com/img/icon256.png "Markdown logo")

Tulemus: Markdown Logo

Viitepildid

![Markdown Logo][logo]

[logo]: https://markdown-here.com/img/icon256.png "Markdown logo"

Tulemus: Markdown Logo

Pilt lingina

[![Markdown Logo](https://markdown-here.com/img/icon256.png)](https://www.markdownguide.org)

Tulemus:

Koodiplokid

Reasisene kood

Kasuta funktsiooni `print()` teksti kuvamiseks.

Tulemus: Kasuta funktsiooni print() teksti kuvamiseks.

Koodiplokid

Taandega koodiplokk (4 tühikut või 1 tabulaator):

    # See on Pythoni kood
    def hello_world():
        print("Tere, maailm!")

Tulemus:

# See on Pythoni kood
def hello_world():
    print("Tere, maailm!")

Piiratud koodiplokk (kolm tagurpidi ülakomat):

```
# See on Pythoni kood
def hello_world():
    print("Tere, maailm!")
```

Tulemus:

# See on Pythoni kood
def hello_world():
    print("Tere, maailm!")

Süntaksi esiletõstmine

```python
# See on Pythoni kood süntaksi esiletõstmisega
def hello_world():
    print("Tere, maailm!")
```

Tulemus:

# See on Pythoni kood süntaksi esiletõstmisega
def hello_world():
    print("Tere, maailm!")

Tabelid

| Päis 1 | Päis 2 | Päis 3 |
|--------|--------|--------|
| Rida 1, veerg 1 | Rida 1, veerg 2 | Rida 1, veerg 3 |
| Rida 2, veerg 1 | Rida 2, veerg 2 | Rida 2, veerg 3 |
| Rida 3, veerg 1 | Rida 3, veerg 2 | Rida 3, veerg 3 |

Tulemus:

Päis 1	Päis 2	Päis 3
Rida 1, veerg 1	Rida 1, veerg 2	Rida 1, veerg 3
Rida 2, veerg 1	Rida 2, veerg 2	Rida 2, veerg 3
Rida 3, veerg 1	Rida 3, veerg 2	Rida 3, veerg 3

Joondamine tabelites

| Vasakule joondatud | Keskele joondatud | Paremale joondatud |
|:-------------------|:-----------------:|-------------------:|
| Tekst | Tekst | Tekst |
| Pikem tekst | Pikem tekst | Pikem tekst |

Tulemus:

Vasakule joondatud	Keskele joondatud	Paremale joondatud
Tekst	Tekst	Tekst
Pikem tekst	Pikem tekst	Pikem tekst

Tsitaadid

> See on tsitaat.
>
> See on tsitaadi teine lõik.
>> See on pesastatud tsitaat.

Tulemus:

See on tsitaat.

See on tsitaadi teine lõik.

See on pesastatud tsitaat.

Horisontaalsed jooned

Horisontaalse joone loomiseks kasuta kolme või enamat tärni (***), miinust (—) või alakriipsu (___) eraldi real:

***

---

___

Tulemus:

Kontrollnimekirjad

- [x] Lõpetatud ülesanne
- [ ] Lõpetamata ülesanne
- [ ] ~~Tühistatud ülesanne~~

Tulemus:

Lõpetatud ülesanne
Lõpetamata ülesanne
~~Tühistatud ülesanne~~

Joonealused märkused

Siin on tekst joonealuse märkusega[^1].

[^1]: See on joonealune märkus.

Tulemus:

Siin on tekst joonealuse märkusega¹.

Definitsioonid

term
: definitsioon

Tulemus:

term: definitsioon

Läbikriipsutatud tekst

~~See tekst on läbikriipsutatud.~~

Tulemus:

~~See tekst on läbikriipsutatud.~~

Emoji

Emoji lisamiseks kasuta kooloneid ja emoji koodi:

:smile: :heart: :thumbsup: 

Hugo frameworkis ei ole toetatud siiki kõik emotikonid, näiteks :bowtie:

Tulemus:

😄 ❤️ 👍

HTML Markdown-is

Markdown toetab HTML-i kasutamist:

<div style="color: red;">
  See tekst on punane.
</div>

<table>
  <tr>
    <td>Rida 1, veerg 1</td>
    <td>Rida 1, veerg 2</td>
  </tr>
  <tr>
    <td>Rida 2, veerg 1</td>
    <td>Rida 2, veerg 2</td>
  </tr>
</table>

Tulemus:

See tekst on punane.

Rida 1, veerg 1	Rida 1, veerg 2
Rida 2, veerg 1	Rida 2, veerg 2

Matemaatilised valemid

Paljud Markdown protsessorid toetavad LaTeX süntaksit matemaatiliste valemite jaoks:

Reasisene valem:  \(E=mc^2\)

Eraldi real olev valem:

$$
\frac{n!}{k!(n-k)!} = \binom{n}{k}
$$

või 
\[
\frac{n!}{k!(n-k)!} = \binom{n}{k}
\]

Tulemus (kui toetatud, aga Hugo seda ei toeta):

Reasisene valem: $E=mc^2$

Eraldi real olev valem:

$$ \frac{n!}{k!(n-k)!} = \binom{n}{k} $$\[ \frac{n!}{k!(n-k)!} = \binom{n}{k} \]

Matemaatika

Siin on võrrand, mida tahaks näha: $ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $

Diagrammid

Mõned Markdown protsessorid toetavad diagrammide loomist Mermaid või muude süntaksite abil:, kuid Hugo ei saa sellega otse hakkama ja peale mõningasi katsetusi andsin ma alla.

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

Tulemus (Hugos ei ole toetatud, see pilt on GitHubist):

Tulemus

Hugo näitab seda aga nii:

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

Laiendatud süntaks

Erinevad Markdown laiendused pakuvad täiendavaid võimalusi:

Ülaindeks

X^2^

Tulemus (Hugo ei toeta ): X^2^

Alaindeks

H~2~O

Tulemus (Hugo ei toeta ): H2O

Märgistatud tekst

==Märgistatud tekst==

Tulemus (Hugo ei toeta ): ==Märgistatud tekst==

Markdown redaktorid

Markdown-i kirjutamiseks on saadaval palju redaktoreid:

Visual Studio Code - tasuta koodiredaktor laiendusega Markdown-i jaoks
Typora - WYSIWYG Markdown redaktor
StackEdit - veebipõhine Markdown redaktor
Dillinger - veebipõhine Markdown redaktor
Obsidian - teadmiste baasi rakendus Markdown toega
iA Writer - minimalistlik Markdown redaktor
Notion - märkmete tegemise rakendus Markdown toega

Kokkuvõte

See ülevaateleht katab enamiku Markdown-i märgendeid ja süntaksit. Pea meeles, et mitte kõik Markdown protsessorid ei toeta kõiki siin kirjeldatud funktsioone, eriti laiendatud süntaksi omi. Alati kontrolli, milliseid funktsioone sinu kasutatav Markdown protsessor toetab.

Markdown-i õppimine on lihtne ja selle kasutamine muudab dokumentide vormindamise palju kiiremaks ja mugavamaks kui traditsiooniliste tekstiredaktorite kasutamine.

See ülevaateleht on loodud õppematerjalina ja võib olla vabalt kasutatud ja jagatud.

See on joonealune märkus. ↩︎