Markdown on yksinkertainen tapa muotoilla tekstiä tavallisilla merkeillä. Sitä käytetään kaikkialla — GitHubissa, Redditissä, Notionissa, Discordissa, teknisessä dokumentaatiossa ja lukemattomilla muilla alustoilla. Sen sijaan, että napsauttaisit painikkeita tehdäksesi tekstin lihavoiduksi tai luodaksesi otsikoita, kirjoitat yksinkertaisia symboleita. Tämä opas opettaa sinulle perusteet ja antaa sinun harjoitella ilmaisella Markdown-esikatselu-työkalullamme.
Mitä tarvitset
- Verkkoselain (Chrome, Firefox, Safari tai Edge)
- Ei tiliä eikä asennusta tarvita
- Noin 10 minuuttia perusteiden oppimiseen
Vaiheittainen opas
Avaa Markdown-esikatselutyökalu
Siirry Markdown-esikatselu-työkaluun. Näet jaetun näytön editorin: vasemmalla puolella kirjoitat Markdownia, ja oikealla puolella näkyy muotoiltu esikatselu reaaliajassa. Jokainen kirjoittamasi muutos näkyy välittömästi esikatselmassa.
Opi perussyntaksi
Aloita kirjoittaminen editoriin kokeillaksesi Markdown-muotoilua. Perussyntaksi on yksinkertainen ja se voidaan oppia minuuteissa. Harjoittele alla olevilla esimerkeillä — kirjoita ne vasemmalle puolelle ja katso muotoillun tuloksen ilmestyvän oikealle.
Kirjoita asiakirjasi
Kirjoita nyt varsinainen sisältösi. Käytä otsikoita asiakirjan jäsentämiseen, listoja tietojen järjestämiseen sekä lihavoitua tai kursivoitua tekstiä korostukseen. Reaaliaikainen esikatselu varmistaa, että tiedät aina, miltä lopputulos näyttää kirjoittaessasi.
Vie tai kopioi tulos
Kun asiakirjasi näyttää haluamaltasi, kopioi Markdown-teksti käytettäväksi millä tahansa alustalla, joka tukee sitä, tai vie muotoiltu tulos. Markdown-sisältösi voidaan liittää GitHubiin, Redditiin, Notioniin tai mihin tahansa Markdown-yhteensopivaan editoriin.
Hyvä tietää Markdown on suunniteltu luettavaksi myös ilman renderöintiä. Markdown-asiakirja näyttää siistiltä ja jäsentyneeltä pelkkänä tekstinä, mikä on yksi syy sen suureen suosioon.
Olennainen Markdown-syntaksi
Otsikot
Käytä #-symboleita otsikoiden luomiseen. Enemmän #-symboleita tarkoittaa pienempiä otsikoita:
# Otsikko 1 (suurin)
## Otsikko 2
### Otsikko 3
#### Otsikko 4
Lihavoitu ja kursivoitu teksti
Kääri teksti tähdillä korostusta varten:
**Tämä on lihavoitu teksti**
*Tämä on kursivoitu teksti*
***Tämä on lihavoitu ja kursivoitu***
Listat
Luo järjestämättömiä listoja viivoilla ja järjestettyjä listoja numeroilla:
- Ensimmäinen kohde
- Toinen kohde
- Kolmas kohde
1. Vaihe yksi
2. Vaihe kaksi
3. Vaihe kolme
Linkit
Luo klikattavia linkkejä hakasulkujen ja sulkujen avulla:
[Linkin teksti](https://example.com)
Koodi
Käytä takaheittomerkkejä rivinsisäiseen koodiin ja kolmea takaheittomerkkiä koodilohkoille:
Rivinsisäinen: `console.log("hello")`
Koodilohko:
```javascript
function greet(name) {
return "Hello, " + name;
}
```
Vinkki Kaikkea ei tarvitse opetella kerralla. Aloita otsikoilla, lihavoidulla tekstillä ja listoilla — nämä kolme kattavat 80 % tyypillisestä Markdown-kirjoittamisesta. Lisää syntaksia sitä mukaa kuin tarvitset.
Kuvat
Lisää kuvia huutomerkillä linkkisyntaksin eteen:
Lainaukset
Käytä >-merkkiä lainatun tekstin luomiseen:
> Tämä on lainaus.
> Se voi ulottua useille riveille.
Missä Markdownia käytetään
| Alusta | Kuinka Markdownia käytetään |
|---|---|
| GitHub | README-tiedostot, ongelmat, vetopyynnöt, kommentit |
| Viestien ja kommenttien muotoilu | |
| Notion | Sivun sisältö ja dokumentaatio |
| Discord | Viestien muotoilu |
| Stack Overflow | Kysymykset, vastaukset ja kommentit |
| Staattisten sivustojen generaattorit | Blogikirjoitukset ja sivun sisältö |
Tärkeää Eri alustat tukevat hieman erilaisia Markdown-ominaisuuksia. Perusteet (otsikot, lihavoitu, kursivoitu, listat, linkit) toimivat kaikkialla. Edistyneet ominaisuudet, kuten taulukot tai alaviitteet, vaihtelevat alustoittain. Esikatsele aina ennen julkaisemista uudella alustalla.
Usein kysytyt kysymykset
Mikä on ero Markdownin ja HTML:n välillä? Markdown muunnetaan HTML:ksi taustalla. Se on yksinkertaisempi tapa kirjoittaa muotoiltua tekstiä ilman HTML-tunnisteiden muistamista. Kaikkialla, jossa Markdown hyväksytään, se renderöidään HTML:nä.
Voinko käyttää Markdownia ammatillisiin asiakirjoihin? Ehdottomasti. Monet tiimit käyttävät Markdownia dokumentaatioon, ehdotuksiin ja raportteihin. Työkaluja on olemassa Markdownin muuntamiseen PDF-, Word- ja esitysmuotoihin.
Onko syntaksi sama kaikkialla? Perussyntaksi on yleismaailmallinen. Jotkut alustat lisäävät laajennuksia (kuten GitHub Flavored Markdown, joka lisää taulukot ja tehtävälistat). Tässä oppaassa käsitellyt perusteet toimivat kaikkialla.
Seuraavat vaiheet
Nyt kun osaat Markdownin, kokeile kirjoittaa README projektiasi varten, muotoile blogikirjoitus tai luo teknistä dokumentaatiota. Edistyneempiä muotoilutehtäviä varten tutustu JSON-muotoilijaan koodidokumentaatioon tai PDF-editoriin lopulliseen asiakirjatulosteeseen.