Opi pikaoppaasta Markdownin syntaksi otsikoille, luetteloille, linkeille, taulukoille ja koodilohkoille ja kokeile sitä editorissa, jossa on reaaliaikainen esikatselu.
Editori ja reaaliaikainen esikatselu
696 / 20 000
Esikatselu
Tervetuloa Markdownin pariin
Markdown muuttaa pelkän tekstin muotoilluksi tekstiksi. Tässä kappaleessa on lihavoituja, kursivoituja ja yliviivattuja sanoja sekä vähän koodia rivin sisällä.
Luettelot
Ensimmäinen kohta
Toinen kohta
Sisäkkäinen kohta
Ensimmäinen vaihe
Toinen vaihe
Valmis tehtävä
Avoin tehtävä
Lainaus, linkki ja taulukko
Yksinkertaisten asioiden pitää olla yksinkertaisia.
Esikatselu toimii selaimessasi. Raaka HTML näytetään tekstinä, kuvien tilalla näkyy paikkamerkki, ja vain http-, https- ja mailto-linkkejä voi klikata.
Syntaksin pikaopas
Näytetään 30/30
**bold text**
Mitä se tekee
Lihavoitu teksti. Myös kaksi alaviivaa kummallakin puolella toimii.
*italic text*
Mitä se tekee
Kursivoitu teksti. Myös yksi alaviiva kummallakin puolella toimii.
***bold and italic***
Mitä se tekee
Lihavointi ja kursivointi yhtä aikaa kolmella tähdellä.
~~crossed out~~
Mitä se tekee
Yliviivattu teksti: kaksi tildeä kummallakin puolella.
First paragraph.
Second paragraph.
Mitä se tekee
Aloita uusi kappale jättämällä tyhjä rivi tekstikappaleiden väliin.
First line\
Second line
Mitä se tekee
Kenoviiva tai kaksi välilyöntiä rivin lopussa aloittaa uuden rivin saman kappaleen sisällä.
\*not italic\*
Mitä se tekee
Kenoviiva Markdown-merkin edessä näyttää merkin sellaisenaan.
# Heading 1
Mitä se tekee
Ylimmän tason otsikko. Lisää välilyönti risuaidan jälkeen.
## Heading 2
Mitä se tekee
Toisen tason otsikko pääosioille.
### Heading 3
Mitä se tekee
Kolmannen tason otsikko alaosioille.
###### Heading 6
Mitä se tekee
Pienin otsikko. Tasoja on yhdestä kuuteen risuaitaa.
Heading 1
=========
Heading 2
---------
Mitä se tekee
Vaihtoehtoinen tapa: alleviivaa teksti yhtäsuuruusmerkeillä tason 1 otsikoksi tai yhdysmerkeillä tason 2 otsikoksi.
- First item
- Second item
- Third item
Mitä se tekee
Numeroimaton luettelo. Aloita jokainen rivi yhdysmerkillä, tähdellä tai plusmerkillä.
1. First item
2. Second item
3. Third item
Mitä se tekee
Numeroitu luettelo. Aloita jokainen rivi numerolla ja pisteellä.
- Parent item
- Child item
- Child item
Mitä se tekee
Sisennä kohtaa vähintään kahdella välilyönnillä, niin se sijoittuu yllä olevan kohdan alle.
- [x] Finished task
- [ ] Open task
Mitä se tekee
Tehtävälista, jossa on valittuja ja valitsemattomia ruutuja.
[link text](https://example.com)
Mitä se tekee
Linkki, jonka näkyvä teksti on hakasulkeissa ja osoite kaarisulkeissa.
[link text](https://example.com "Tooltip")
Mitä se tekee
Linkki, jolla on työkaluvihje. Vihje kirjoitetaan lainausmerkkeihin osoitteen perään.
Kuva. Kirjoitetaan kuten linkki, mutta eteen tulee huutomerkki; hakasulkeiden teksti kuvailee kuvaa.
`inline code`
Koodi virkkeen sisällä takahipsujen ympäröimänä.
`` code with a ` backtick ``
Käytä kahta takahipsua, kun koodissa itsessään on takahipsu.
```
code block
```
Koodilohko kahden rivin välissä, joilla on kolme takahipsua. Sisällä oleva teksti säilyy juuri sellaisena kuin se on kirjoitettu.
```js
console.log("Hi");
```
Lisää kielen nimi avaavien takahipsujen perään, niin editorit voivat korostaa koodin.
> Quoted text
Lainattu teksti. Aloita rivi suurempi kuin -merkillä.
> Quoted text
>> Nested quote
Lisää toinen suurempi kuin -merkki, niin voit lainata lainauksen sisällä.
---
Vaakaviiva. Kirjoita omalle rivilleen vähintään kolme yhdysmerkkiä, tähteä tai alaviivaa.
| Name | Qty |
| --- | --- |
| Apple | 3 |
| Pear | 5 |
Taulukko. Erota sarakkeet pystyviivoilla ja lisää otsikkorivin alle rivi yhdysmerkkejä.
| Left | Center | Right |
| :--- | :---: | ---: |
| a | b | c |
Erotinrivin kaksoispisteet tasaavat sarakkeen vasemmalle, keskelle tai oikealle.
Mikä Markdown on
Markdown on tapa kirjoittaa muotoiltuja asiakirjoja pelkkänä tekstinä. Muutama tavallisten sanojen ympärille kirjoitettu merkki merkitsee otsikot, korostukset, luettelot, linkit ja koodin, ja teksti pysyy luettavana jo ennen muuntamista.
Sitä käytetään README-tiedostoissa, dokumentaatiossa, muistiinpanosovelluksissa, pikaviesteissä ja monissa blogityökaluissa. Yllä oleva editori näyttää kirjoittaessasi, miltä kukin syntaksin osa näyttää valmiina.
Vinkkejä siistiin Markdowniin
Useimmat ongelmat johtuvat välilyönneistä ja tyhjistä riveistä, eivät itse merkeistä.
Lisää välilyönti otsikon risuaitojen ja luettelomerkin jälkeen.
Jätä tyhjä rivi otsikoiden, luetteloiden, lainausten ja koodilohkojen eteen ja jälkeen.
Sisennä sisäkkäiset luettelokohdat niin, että ne ovat samalla tasalla ylemmän kohdan tekstin kanssa.
Lisää kenoviiva merkin, kuten * tai _, eteen, kun haluat näyttää sen sellaisenaan.
Usein kysytyt kysymykset (FAQ)
Näyttääkö Markdown samalta kaikkialla?+
Perusasiat näyttävät. Otsikot, korostukset, luettelot, linkit ja koodi noudattavat CommonMark-standardia lähes kaikkialla. Taulukot, tehtäväluettelot ja yliviivaus ovat GitHubin tunnetuiksi tekemiä laajennuksia, joten muutamat sovellukset eivät tue niitä.
Miksi esikatselu ei suorita HTML-koodiani tai lataa kuviani?+
Esikatselua on rajoitettu tarkoituksella. Raaka HTML näytetään tekstinä, kuvia ei ladata vaan niiden tilalla näkyy nimetty paikkamerkki, ja vain http-, https- ja mailto-linkkejä voi klikata.
Lähetetäänkö kirjoittamani teksti jonnekin?+
Ei. Esikatselu luodaan selaimessasi, eikä tekstiä ladata palvelimelle tai tallenneta.