Markdown-syntaksiohje

Olennaista syntaksia dokumenttien muotoiluun

Yleiskatsaus

Markdown on kevyt merkintäkieli, jolla voit lisätä muotoiluelementtejä pelkkään tekstiin. John Gruberin luoma 2004 Markdown on nyt yksi maailman suosituimmista merkintäkielistä.

Markdownin käyttö eroaa WYSIWYG-editorista. Esimerkiksi Microsoft Wordissa napsautat painikkeita sanojen ja lauseiden muotoiluun, ja muutokset näkyvät heti. Markdown ei toimi niin. Kun luot Markdown-muotoillun tiedoston, lisäät Markdown-syntaksia tekstiin osoittaaksesi, mitkä sanat ja lauseet näyttävät erilaisilta.

Otsikot

Luo otsikko lisäämällä risuaita (#) sanan tai lauseen eteen. Risuaiden määrä vastaa otsikon tasoa. Esim. kolmannen tason otsikko: ### Otsikkoni.

Markdown
HTML
Renderöity tulos
# Heading level 1
<h1>Heading level 1</h1>

Heading level 1

## Heading level 2
<h2>Heading level 2</h2>

Heading level 2

### Heading level 3
<h3>Heading level 3</h3>

Heading level 3

#### Heading level 4
<h4>Heading level 4</h4>

Heading level 4

##### Heading level 5
<h5>Heading level 5</h5>
Heading level 5
###### Heading level 6
<h6>Heading level 6</h6>
Heading level 6

Kappaleet

Luo kappaleita käyttämällä tyhjää riviä yhden tai useamman tekstirivin erottamiseen.

Markdown
HTML
Renderöity tulos
I really like using Markdown.

It lets me write easily.
<p>I really like using Markdown.</p>
<p>It lets me write easily.</p>

I really like using Markdown.

It lets me write easily.

Rivinvaihdot

Luo rivinvaihto tai uusi rivi lopettamalla rivi kahdella tai useammalla välilyönnillä ja painamalla sitten enter.

Markdown
HTML
Renderöity tulos
This is the first line.
And this is the second line.
<p>This is the first line.<br>
And this is the second line.</p>

This is the first line.
And this is the second line.

Korostus

Voit korostaa tekstiä lihavoimalla tai kursivoimalla.

Lihavoi

Lihavoidaksesi tekstin, lisää kaksi asteriskia (**) tai alaviivaa (__) sanan tai lauseen eteen ja perään.

Markdown
HTML
Renderöity tulos
I just love **bold text**.
I just love <strong>bold text</strong>.

I just love bold text.

I just love __bold text__.
I just love <strong>bold text</strong>.

I just love bold text.

Kursivoi

Kursivoidaksesi tekstin, lisää yksi asteriski (*) tai alaviiva (_) sanan tai lauseen eteen ja perään.

Markdown
HTML
Renderöity tulos
The *cat* meows.
The <em>cat</em> meows.

The cat meows.

The _cat_ meows.
The <em>cat</em> meows.

The cat meows.

Lihavoi ja kursivoi

Korosta tekstiä sekä lihavoituna että kursiivina lisäämällä kolme asteriskia (***) tai alaviivaa (___) sanan tai lauseen eteen ja perään.

Markdown
HTML
Renderöity tulos
This text is ***really important***.
This text is <strong><em>really important</em></strong>.

This text is really important.

This text is ___really important___.
This text is <strong><em>really important</em></strong>.

This text is really important.

Lainauslohkot

Luo lainauslohko lisäämällä > kappaleen eteen.

Markdown
HTML
Renderöity tulos
> Dorothy followed her through many of the beautiful rooms in her castle.
<blockquote><p>Dorothy followed her through many of the beautiful rooms in her castle.</p></blockquote>

Dorothy followed her through many of the beautiful rooms in her castle.

Sisäkkäiset lainauslohkot

Lainauslohkot voi sisäkkäistää. Lisää >> sen kappaleen eteen, jonka haluat sisäkkäiseksi.

Markdown
Renderöity tulos
> Dorothy followed her through many of the beautiful rooms in her castle.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Luettelot

Voit järjestää kohdat järjestetyiksi ja järjestämättömiksi luetteloiksi.

Järjestetyt luettelot

Järjestettyyn luetteloon lisää rivejä numeroilla ja pisteen. Numeroiden ei tarvitse olla numeerisessa järjestyksessä, mutta luettelon tulee alkaa ykkösellä.

Markdown
HTML
Renderöity tulos
1. First item
2. Second item
3. Third item
4. Fourth item
<ol>
  <li>First item</li>
  <li>Second item</li>
  <li>Third item</li>
  <li>Fourth item</li>
</ol>
  1. First item
  2. Second item
  3. Third item
  4. Fourth item

Järjestämättömät luettelot

Järjestämättömään luetteloon lisää viivoja (-), asteriskeja (*) tai plusmerkkejä (+) rivien eteen.

Markdown
HTML
Renderöity tulos
- First item
- Second item
- Third item
- Fourth item
<ul>
  <li>First item</li>
  <li>Second item</li>
  <li>Third item</li>
  <li>Fourth item</li>
</ul>
  • First item
  • Second item
  • Third item
  • Fourth item

Koodi

Merkitse sana tai lause koodiksi laittamalla se takaslasheen (`) väliin.

Markdown
HTML
Renderöity tulos
At the command prompt, type `nano`.
At the command prompt, type <code>nano</code>.

At the command prompt, type nano.

Koodilohkot

Luo koodilohko sisentämällä jokainen rivi vähintään neljällä välilyönnillä tai yhdellä sarkaimella, tai käytä kolmea takaslashea (```) koodilohkon eteen ja perään.

Markdown
Renderöity tulos
```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Vaakaviivat

Luo vaakaviiva käyttämällä kolmea tai useampaa asteriskia (***), viivaa (---) tai alaviivaa (___) omalla rivillään.

Markdown
HTML
Renderöity tulos
***
<hr>

---
<hr>

___
<hr>

Kuvat

Lisää kuva lisäämällä huutomerkki (!), sen jälkeen vaihtoehtoinen teksti hakasulkeissa ja kuvan polku tai URL sulkeissa. Voit halutessasi lisätä otsikon lainausmerkeissä polun tai URL:n perään.

Markdown
HTML
Renderöity tulos
![The San Juan Mountains](https://mdg.imgix.net/assets/images/san-juan-mountains.jpg "San Juan Mountains")
<img src="https://mdg.imgix.net/assets/images/san-juan-mountains.jpg" alt="The San Juan Mountains" title="San Juan Mountains">
The San Juan Mountains

Escape-merkit

Näyttääksesi kirjaimellisen merkin, jota muuten käytetään Markdown-dokumentin muotoiluun, lisää kenoviiva (\) merkin eteen.

Markdown
Renderöity tulos
\* Without the backslash, this would be a bullet in an unordered list.

* Without the backslash, this would be a bullet in an unordered list.

Merkit, joita voit escapettaa

Voit käyttää kenoviivaa seuraavien merkkien escapettamiseen:

\backslash
`backtick
*asterisk
_underscore
{ }curly braces
[ ]brackets
( )parentheses
#pound sign
+plus sign
-minus sign (hyphen)
.dot
!exclamation mark
|pipe

Taulukot

Luo taulukko käyttämällä kolmea tai useampaa viivaa (---) kunkin sarakkeen otsikkoon ja pystyviivoja (|) sarakkeiden erottamiseen. Voit halutessasi lisätä pystyviivat taulukon molempiin päihin.

Markdown
Renderöity tulos
| Syntax    | Description |
| --------- | ----------- |
| Header    | Title       |
| Paragraph | Text        |
SyntaxDescription
HeaderTitle
ParagraphText

Tasaus

Voit tasata tekstin sarakkeissa vasemmalle, oikealle tai keskelle lisäämällä kaksoispisteen (:) viivojen vasemmalle, oikealle tai molemmille puolille otsikkorivillä.

Markdown
Renderöity tulos
| Align Left | Align Center | Align Right |
| :--- | :---: | ---: |
| This | This | This |
| column | column | column |
| will | will | will |
| align | align | align |
| left | center | right |
Tasaa vasemmalleKeskitäTasaa oikealle
ThisThisThis
columncolumncolumn
willwillwill
alignalignalign
leftcenterright