Markdown selitettynä 5 minuutissa

Olet todennäköisesti käyttänyt Markdownia tietämättäsi. Oletko koskaan kirjoittanut **lihavoitu** Slack-viestissä? Kirjoittanut README:n GitHubissa? Muotoillut Reddit-viestiä? Se on Markdown.

Markdown on kevyt tapa muotoilla pelkkää tekstiä yksinkertaisilla symboleilla. Sen sijaan, että klikkaisit työkalupalkin painikkeita lihavointia, kursiivia, otsikoita ja listoja varten, kirjoitat muutaman merkin, jotka ilmaisevat haluamasi muotoilun. Sen loi vuonna 2004 John Gruber ja Aaron Swartz, ja siitä on tullut oletusmuotoilukieli kehittäjille, kirjoittajille ja kaikille jotka työskentelevät verkon tekstin kanssa.

Miksi Markdown on olemassa

Ennen Markdownia, tekstin muotoilu verkkoon tarkoitti HTML:n kirjoittamista. Tehdäksesi sanan lihavoiduksi, kirjoitit <strong>lihavoitu</strong>. Listan luomiseen tarvitset <ul><li>kohde</li></ul>. HTML on tehokas mutta sanallinen ja vaikealukuinen raakamuodossaan.

Markdown ratkaisee tämän tarjoamalla ihmisluettavan lyhennetavan. Raakakielinen teksti on helppolukuista ennen renderöintiä. Muotoiltu tuloste on siistimpi ja ammattimainen. Saat molempien maailmojen parhaat puolet: luettavan lähdetekstin ja viimeistellyn tulosteen.

Olennainen syntaksi

Tässä on kaikki mitä sinun täytyy tietää aloittaaksesi Markdownin tuottavan käytön.

Otsikot

Käytä ristikkoviivoja (#) otsikoiden luomiseen. Enemmän ristikkoja tarkoittaa pienempiä otsikoita.

# Otsikko 1 (suurin)
## Otsikko 2
### Otsikko 3
#### Otsikko 4

Lihavointi ja kursiivi

Kääri teksti tähdillä tai alaviivoilla:

**lihavoitu teksti**
*kursiiviteksti*
***lihavoitu ja kursiivi***

Listat

Järjestämättömät listat käyttävät viivoja, tähtiä tai plusmerkkejä. Järjestetyt listat käyttävät numeroita.

- Ensimmäinen kohde
- Toinen kohde
- Kolmas kohde

1. Ensimmäinen vaihe
2. Toinen vaihe
3. Kolmas vaihe

Linkit

Hakasulkeet tekstille, sulkeet URL:lle:

[Klikkaa tästä](https://example.com)

Kuvat

Kuten linkit, mutta huutomerkki edessä:

![Vaihtoehtoinen teksti](kuva-url.jpg)

Lainaukset

Käytä suurempi-kuin-symbolia:

> Tämä on lainaus. Se sisennetään ja tyylitellään eri tavalla.

Koodi

Gravismerkkejä inline-koodille, kolme gravismerkkiä koodilohkoille:

Käytä `print()`-funktiota tekstin tulostamiseen.

Monirivisille koodilohkoille käytä kolmea gravismerkkiä valinnaisella kielen tunnisteella:

```python
def hei():
    print("Hei, maailma!")
```

Vaakaviivat

Kolme tai useampi viiva, tähti tai alaviiva:

---

Taulukot

Käytä pystypalkkeja ja viivoja:

| Nimi | Rooli | Sijainti |
| --- | --- | --- |
| Alice | Kehittäjä | Berliini |
| Bob | Suunnittelija | Lontoo |

Missä Markdownia käytetään

Markdown on kaikkialla:

Ohjelmistokehitys

• GitHub, GitLab, Bitbucket: README:t, ongelmat, pull-pyynnöt ja dokumentaatio kirjoitetaan kaikki Markdownilla.
• Stack Overflow: Kysymykset ja vastaukset käyttävät Markdown-muotoilua.
• Koodidokumentaatio: Monet dokumentaatiogeneraattorit (Docusaurus, MkDocs, Jekyll) käyttävät Markdownia lähdemuotonaan.

Viestintä

• Slack: Tukee Markdownin osajoukkoa viestien muotoiluun.
• Discord: Käyttää Markdownia lihavointiin, kursiiviin, koodilohkoihin ja muuhun.
• Reddit: Viestit ja kommentit muotoillaan Markdownilla.

Kirjoittaminen ja julkaiseminen

• Blogit: Monet staattisen sivuston generaattorit käyttävät Markdown-tiedostoja sisältölähteinä.
• Kirjat: Useat julkaisutyökalut hyväksyvät Markdown-käsikirjoituksia.
• Muistiinpanot: Sovellukset kuten Obsidian, Notion, Bear ja Typora on rakennettu Markdownin ympärille.

Dokumentaatio

• Tekninen dokumentaatio: API-dokumentaatio, käyttäjäoppaat ja wikit käyttävät yleisesti Markdownia.
• Sisäiset tietopankit: Monet tiimit käyttävät Markdown-pohjaisia wikejä.

Markdown-murteet

Yksi asia tietää: on olemassa eri "murteita" Markdownia. Ydinsyntaksi on sama kaikkialla, mutta jotkut alustat lisäävät laajennuksia:

Erot ovat lähinnä edistyneissä ominaisuuksissa. Perusteet (otsikot, lihavointi, kursiivi, listat, linkit, kuvat, koodi) toimivat samoin kaikkialla.

Yleisiä virheitä

Tyhjien rivien unohtaminen

Markdown vaatii tyhjän rivin ennen ja jälkeen monien elementtien. Otsikko tarvitsee tyhjän rivin ennen sitä. Lista tarvitsee tyhjän rivin ennen ja jälkeen. Näiden tyhjien rivien unohtaminen on yleisin renderöintiongelmien lähde.

Epäjohdonmukainen listan merkintä

Sekoittaminen -, * ja + samassa listassa voi aiheuttaa odottamatonta renderöintiä. Valitse yksi ja pidä siitä kiinni.

Välit symbolien jälkeen

Jotkut Markdown-prosessorit vaativat välin #:n jälkeen otsikoissa ja -:n jälkeen listoissa. Lisää aina väli varmuuden vuoksi.

# Oikea otsikko
#Väärä otsikko

- Oikea listan kohde
-Väärä listan kohde

Miksi Markdown kannattaa oppia

Markdownin oppiminen vie viisi minuuttia ja säästää tunteja ajan myötä. Kun osaat sen, voit:

• Kirjoittaa dokumentaatiota joka renderöityy kauniisti GitHubissa
• Muotoilla viestejä Slackissa ja Discordissa koskematta hiirtä
• Ottaa rakenteellisia muistiinpanoja jotka ovat siirrettävissä sovellusten välillä
• Luoda blogikirjoituksia ja verkkosisältöä pelkistä tekstitiedostoista
• Tehdä yhteistyötä tekstipohjaisissa asiakirjoissa ilman formaattiyhteensopivuusongelmia

Investoinnin ja hyödyn suhde on yksi parhaimmista koko teknologiamaailmassa.

Aloita Markdownin kirjoittaminen heti:

• Kirjoita ja esikatsele Markdownia
• Markdown-esikatselutyökalu

Ilmainen, selaimessasi, reaaliaikaisella esikatselulla kirjoittaessasi.