Markdown-luonnos

Reaaliaikainen esikatselu

Markdown-esikatseluesimerkkejä

Kirjoita Markdownia ja katso renderöity HTML. Esimerkki:

Esimerkki: Tilaajasuunnitelma

Markdown-syöte

Renderöity HTML:

HTML-tulos

Klikkaa Esimerkki-painiketta ladataksesi lisää esimerkkejä editoriin.

Mikä on Markdown-esikatselu?

Markdown on pelkkää tekstiä, jossa on syntaksi otsikoille, listoille ja linkeille. Markdown-esikatselu antaa sinun kirjoittaa ja nähdä renderöidyn HTML:n reaaliajassa. CommonMark-spesifikaatio määrittelee syntaksin.

Tämä työkalu toimii kokonaan selaimessasi. Mitään ei lähetetä palvelimelle. Kopioi HTML tai lataa se muualle käytettäväksi. Markdownin muotoiluun käytä Markdown-muotoilutyökalua. Pelkkää muunnosta varten käytä Markdown HTML:ksi.

Kuinka käyttää tätä työkalua

1

Liitä tai lataa

Kopioi Markdownisi ja liitä se vasempaan editoriin. Voit myös klikata Lataa ladataksesi .md- tai .markdown-tiedoston. Esimerkki-painike lataa esimerkkidatan.

2

Tarkista reaaliaikainen esikatselu

Oikea paneeli näyttää renderöidyn HTML:n. Muokkaa vasemmalla; esikatselu päivittyy reaaliajassa. Käytä Kopioi HTML tai Lataa HTML saadaksesi tulosteen.

3

Kopioi tai lataa

Käytä Kopioi HTML tai Lataa HTML saadaksesi renderöidyn tulosteen. Muotoilua tai validointia varten käytä Markdown-muotoilutyökalua tai Markdown-validaattoria.

Milloin Markdown-esikatselu auttaa

Kun kirjoitat dokumentaatiota, README-tiedostoja GitHubiin tai sisältöä ja haluat välitöntä palautetta, reaaliaikainen esikatselu näyttää tarkalleen miten se renderöityy. GFM-spesifikaatio määrittelee taulukot ja tehtävälistat. Erinomainen Jekyllille, Hugolle tai dokumentaatioon. Täydelliseen editoriin latausvaihtoehdoilla käytä Markdown-editoria.

Usein kysyttyä

Mitä Markdownin "renderöinti" tarkoittaa?

Renderöinti muuntaa Markdown-syntaksin pelkässä tekstissä — kuten **lihavoitu** tai # Otsikko — oikeiksi HTML-elementeiksi kuten <strong> ja <h1>. Tämä työkalu renderöi Markdownisi reaaliajassa, joten näet tarkalleen miltä se näyttää julkaistuna.

Mitä Markdown-spesifikaatiota tämä työkalu noudattaa?

Esikatselu noudattaa CommonMark-spesifikaatiota, joka on laajimmin käytetty Markdown-standardi. Se tukee myös GitHub Flavored Markdown (GFM)-laajennuksia kuten taulukoita, tehtävälistoja ja yliviivausta.

Voinko käyttää tätä README-tiedostojen esikatseluun?

Ehdottomasti. Liitä README-Markdownisi editoriin ja esikatselu näyttää miten se renderöityy — mukaan lukien GFM-taulukot ja tehtävälistat, joita GitHub käyttää. Nopea tapa havaita muotoiluongelmat ennen commitia.

Lähetetäänkö sisältöni palvelimelle?

Ei — kaikki toimii paikallisesti selaimessasi. Markdownisi ei koskaan poistu laitteeltasi. Ei latauksia, tilejä eikä seurantaa. Täysin yksityinen.

Entä raaka HTML?

Raaka HTML Markdownissa läpäistään yleensä esikatseluun. HTML:n muuntamiseen Markdowniksi käytä HTML Markdowniksi.

Liittyvät työkalut

Lue lisää: CommonMark, CommonMark-spesifikaatio, Markdown Guide, GFM, W3C HTML, GitHub, Jekyll.