Markdown-pikaopas

Kätevä pikakatsaus Markdown-syntaksiin — otsikot, listat, linkit, taulukot, koodilohkot ja paljon muuta valmiine kopiointiesimerkkeineen.

Kokeile Markdownia

Pikaopas

Mikä on Markdown-pikaopas?

Markdown on pelkkää tekstiä käyttävä formaatti jäsennellyille asiakirjoille. Pikaopas on nopea hakemisto syntaksille: otsikot, listat, linkit, taulukot, koodilohkot ja paljon muuta. CommonMark-määrittely ja GitHub Flavored Markdown (GFM) määrittelevät syntaksin, jota käytetään README-tiedostoissa, dokumentaatiossa ja wikeissä.

Tämä työkalu näyttää valmiiksi kopioitavan pikaoppaan oikeassa paneelissa. Käytä vasenta editoria syntaksin kokeiluun ja nähdäksesi miltä se näyttää. Kopioi tai lataa pikaopas offline-käyttöön. Taulukoiden luomiseen CSV:stä käytä Markdown-taulukkogeneraattoria.

Miten työkalua käytetään

1

Tutustu pikaoppaaseen

Oikea paneeli näyttää otsikot, korostukset, listat, linkit, kuvat, lainaukset, koodin, taulukot, tehtävälistat ja vaakaviivat. Jokainen esimerkki käyttää vakiomuotoista CommonMark- ja GFM-syntaksia.

2

Kokeile Markdownia editorissa

Liitä tai kirjoita Markdownia vasempaan editoriin. Käytä Esimerkki-painiketta ladataksesi esimerkkisisältöä. Kokeile lihavointia, kursivointia, listoja ja taulukoita. Olemassa olevan Markdownin muotoiluun käytä Markdown-muotoilijaa.

3

Kopioi tai lataa

Kopioi pikaopas leikepöydällesi tai lataa se .md-tiedostona. Markdownin muuntamiseen HTML:ksi käytä Markdown HTML:ksi. Sisällysluettelon luomiseen otsikoista käytä Markdown-sisällysluettelogeneraattoria.

Pikaopas

Markdownin perussyntaksi

Markdown:

# Heading 1
## Heading 2

**bold** and *italic* and `code`

- List item 1
- List item 2

[Link text](https://example.com)

> Blockquote

Näytetään muodossa:

Large heading
Medium heading

Bold text, italic text, and inline code

Bulleted list with two items

Clickable hyperlink

Indented block quote

Missä pikaopas auttaa

Uudet Markdown-käyttäjät tarvitsevat nopean hakemiston. Markdown Guide ja GitHub-dokumentaatio tarjoavat oppaat; pikaopas täydentää niitä kopioi-liitä-esimerkeillä. Taulukot, tehtävälistat ja aidatut koodilohkot ovat yleisiä README-tiedostoissa ja dokumentaatiossa.

Markdownin tyylillisten ongelmien tarkistamiseen käytä Markdown-lintteriä. Syntaksin validointiin käytä Markdown-validaattoria. HTML:n muuntamiseen Markdowniksi käytä HTML Markdowniksi.

Usein kysyttyä

Mitä eroa on Markdownilla ja HTML:llä?

Markdown on kevyt merkintäkieli, joka muuntuu HTML:ksi. Sen sijaan että kirjoitat <strong>lihavoitu</strong>, kirjoitat **lihavoitu**. Markdown on nopeampaa kirjoittaa ja helpompi lukea pelkkänä tekstinä. Sitä käytetään laajalti dokumentaatiossa, README-tiedostoissa ja sisällöntuotannossa.

Onko Markdown sama kaikkialla?

Ei täysin. Alkuperäisessä Markdown-määrittelyssä on epäselvyyksiä, joten eri alustat toteuttavat pieniä variaatioita. CommonMark on standardoitu määrittely, jota useimmat työkalut noudattavat. GitHub Flavored Markdown (GFM) lisää tehtävälistat ja taulukot.

Miten lisään rivinvaihdon Markdownissa?

Lopeta rivi kahdella tai useammalla välilyönnillä ennen Enter-painallusta, tai käytä kenoviivaa \ rivin lopussa. Jotkut jäsentimet käsittelevät myös tyhjää riviä kappaleiden välissä rivinvaihtona. Käytös vaihtelee hieman Markdown-varianttien välillä.

Voinko käyttää HTML:ää Markdownissa?

Kyllä — useimmat Markdown-jäsentimet sallivat raakaa HTML:ää inline-muodossa. Voit käyttää <br>-, <div>-, <span>- ja useimpia muita HTML-tageja suoraan Markdown-tiedostoissa. Hyödyllistä sisällön keskittämiseen tai mukautettujen tyylien lisäämiseen.

Onko datani yksityistä?

Kyllä. Kaikki toimii selaimessasi. Mitään sisältöä ei lähetetä palvelimelle.

Liittyvät työkalut

Markdown-muotoilutyokalu Markdown-taulukko-generaattori Markdown-sisallysluettelo Markdown HTML:ksi Markdown-linter Markdown-tarkistin JSON-muotoilutyokalu

Lue lisää: CommonMark, CommonMark-määrittely, GitHub Flavored Markdown, Markdown Guide, GitHub.