Markdown-syntaksin opas

Selkeä kaava-apu arjen Markdowniin. Jokainen lohko näyttää syntaksin ja sen tuottaman tuloksen.

Mikä on Markdown?

Markdown on kevyt tapa lisätä pelkkään tekstiin muotoilu. Painikkeiden ja valikoiden sijaan käytät muutamaa yksinkertaista merkkiä, kuten #-merkkiä otsikkoon tai *-merkkiä korostukseen, ja teksti pysyy luettavana raakamuodossakin.

John Gruberin ja Aaron Swartzin vuonna 2004 luoma Markdown on noussut standardiksi README-tiedostoille, dokumentaatiolle ja muistiinpanoille sekä sivustoille kuten GitHub ja Reddit. Koska se on pelkkää tekstiä, kirjoituksesi pysyvät siirrettävinä ja luettavina kaikkialla.

Tämä opas käsittelee yleisimmin tarvitsemasi syntaksin. Avaa mikä tahansa esimerkki Markdown Peekissä ja vaihda Välilyönnillä lähdetekstin ja muotoillun tuloksen välillä.

Otsikot

Aloita rivi yhdellä–kuudella #-merkillä. Mitä enemmän risuaitoja, sitä pienempi ja alempi otsikko.

Markdown

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Tulos

Heading 1

Heading 2

Heading 3

Heading 4

Lihavointi, kursivointi ja muuta

Ympäröi teksti merkeillä korostaaksesi sitä. Yhdistele vapaasti.

Markdown

**Bold text**
*Italic text*
***Bold and italic***
~~Strikethrough~~
`Inline code`

Tulos

Bold text

Italic text

Bold and italic

~~Strikethrough~~

Inline code

Listat

Käytä viivaa, tähteä tai plusmerkkiä luettelomerkkeihin ja numeroita numeroituun listaan. Sisennä tehdäksesi sisäkkäisen listan.

Markdown

- First item
- Second item
  - Nested item
- Third item

1. Step one
2. Step two

Tulos

First item
Second item
- Nested item
Third item

Step one
Step two

Linkit

Laita näkyvä teksti hakasulkeisiin ja osoite kaarisulkeisiin. Pelkkä verkko- tai sähköpostiosoite muuttuu linkiksi itsestään.

Markdown

[Markdown Peek](https://markdownpeek.com)
https://markdownpeek.com

Tulos

Markdown Peek

https://markdownpeek.com

Kuvat

Kuva on linkki, jonka edessä on huutomerkki. Hakasulkeissa oleva teksti on vaihtoehtoinen teksti.

Markdown

![A cat looking up](cat.jpg)

Tulos

Lainaukset

Aloita rivi >-merkillä lainataksesi sen. Lisää toinen > tehdäksesi lainauksen lainauksen sisään.

Markdown

> A quote worth remembering.
>
> > And a nested one.

Tulos

A quote worth remembering.
And a nested one.

Koodi

Kääri rivinsisäinen koodi yksittäisiin gravis-merkkeihin ja kokonaiset lohkot kolmeen gravis-merkkiin. Lisää kielen nimi, niin Markdown Peek värittää koodin kuten GitHub.

Markdown

Use `backticks` for inline code.

```js
function hi() {
  console.log("Hello");
}
```

Tulos

Use backticks for inline code.

function hi() {
  console.log("Hello");
}

Taulukot

Erota sarakkeet pystyviivoilla ja alleviivaa otsikkorivi viivoilla. Kaksoispisteet määräävät tasauksen.

Markdown

| Feature | Supported |
|---------|:---------:|
| Tables  | Yes       |
| Code    | Yes       |

Tulos

Feature	Supported
Tables	Yes
Code	Yes

Vaakaviivat

Kolme tai useampi viiva, tähti tai alaviiva omalla rivillään piirtää erottimen.

Markdown

Above the line.

---

Below the line.

Tulos

Above the line.

Below the line.

Tehtävälistat

Listakohta, jossa on [ ], on avoin tehtävä, ja [x] on tehty.

Markdown

- [x] Read the guide
- [ ] Set as default app

Tulos

Read the guide
Set as default app

Huomautuslaatikot

Aloita lainaus merkinnällä [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] tai [!CAUTION], niin siitä tulee värillinen huomautuslaatikko, kuten GitHubissa.

Markdown

> [!NOTE]
> Useful to know, even when skimming.

> [!WARNING]
> Needs attention right away.

Tulos

Note

Useful to know, even when skimming.

Warning

Needs attention right away.

Alaviitteet

Lisää [^1] kohtaan, johon huomautus kuuluu, ja kirjoita huomautus mihin tahansa alemmas. Markdown Peek numeroi huomautukset, listaa ne loppuun ja linkittää takaisin kohtaan, jossa olit.

Markdown

Markdown was created in 2004.[^1]

[^1]: By John Gruber and Aaron Swartz.

Tulos

Markdown was created in 2004.¹

By John Gruber and Aaron Swartz. ↩︎

Front matter

Avain–arvo-parit kahden --- -rivin välissä aivan tiedoston alussa, kuten blogikirjoituksissa ja agenttitaidoissa, näkyvät siistinä taulukkona.

Markdown

---
title: Lofoten
author: Sam
tags: travel
---

# Five nights in March

Tulos

title	author	tags
Lofoten	Sam	travel

Five nights in March

Merkkien ohittaminen

Laita kenoviiva merkin eteen, niin se näkyy sellaisenaan muotoilun sijaan.

Markdown

\*Not italic\*
\# Not a heading

Tulos

*Not italic*

# Not a heading

Matematiikka LaTeXilla

Kääri LaTeX yksittäisiin dollarimerkkeihin lauseen sisäistä matematiikkaa varten tai kaksoisdollarimerkkeihin omalle rivilleen tulevaa kaavaa varten. Markdown Peek esittää molemmat ilman verkkoyhteyttä.

Markdown

Inline math like $E = mc^2$ works in a sentence.

$$
a^2 + b^2 = c^2
$$

Tulos

Inline math like E = mc² works in a sentence.

a 2 + b 2 = c 2

Kaaviot Mermaidilla

Avaa aidattu koodilohko sanalla mermaid ja kuvaa vuokaavio tai sekvenssikaavio pelkkänä tekstinä. Markdown Peek piirtää sen puolestasi vaaleassa tai tummassa tilassa.

Markdown

```mermaid
flowchart LR
  A[Write] --> B[Preview]
  B --> C[Share]
```

Tulos

Lue Markdownia kauniisti Macilla

Markdown Peek esittää minkä tahansa .md-tiedoston siistillä GitHub-tyylillä, koodi väreissä, Quick Look Finderissa ja PDF-tallennus. Ilmainen Mac App Storessa.