Johdanto Markdown-kieleen

Tredun ohjelmistokehittäjien kurssimateriaaleja

Johdanto Markdown-kieleen

Markdown on kevyt merkintäkieli, joka kehitettiin vuonna 2004 helpottamaan muotoillun tekstin kirjoittamista ilman monimutkaista koodia. Sen loivat John Gruber ja Aaron Swartz, ja sitä käytetään laajasti esimerkiksi dokumentaation, blogipostausten ja README-tiedostojen kirjoittamiseen – erityisesti GitHubissa.

Markdownin idea on, että teksti pysyy helposti luettavana myös ilman muotoilun tulkintaa. Tämä tekee siitä erinomaisen työkalun ohjelmistokehityksessä, missä dokumentaatio on tärkeää mutta usein halutaan pysyä yksinkertaisissa ja versionhallintaan sopivissa tiedostomuodoissa, kuten .md.


Perusmuotoilut Markdownissa

Alla on yleisimmät Markdownin muotoilut ja esimerkkejä niiden käytöstä.

Otsikot

Otsikot tehdään #-merkeillä rivin alussa:

# Otsikko 1 ## Otsikko 2 ### Otsikko 3

Lihavointi ja kursivointi

*Lihavoitu teksti* **Kursivoitu teksti** ***Lihavoitu ja kursivoitu teksti***

Listat

Numeroitu lista:

1. Ensimmäinen 2. Toinen 3.Kolmas

Numeroimaton lista:

- Ensimmäinen - Toinen - Kolmas

Myös * toimii viivamerkkinä.

Linkit ja kuvat

Linkki:

[Google](google.com)

![Kuva](kuva.jpg)

Koodi

Yksittäinen koodisana rivin sisällä:

`print("Hello, World!")\`

Vaakaviiva

Vaakaviivan saa aikaan useammalla peräkkäisellä väliviivalla.

----

Missä Markdownia käytetään?

Markdownia käytetään muun muassa:

Yhteenveto

Markdown on helppo tapa kirjoittaa siistiä, muotoiltua tekstiä ilman monimutkaista editoria. Opettelemalla Markdownin perusteet voit tehdä ammattimaisen näköistä dokumentaatiota, jota on helppo lukea ja ylläpitää – sekä koneen että ihmisen.