Markdown-syöte

Renderöity esikatselu

Markdown-katselun esimerkkejä

Katso Markdownia heti päivittyvällä HTML-esikatselulla. Esimerkki:

Esimerkki: Tilaajasuunnitelma

Markdown-syöte

Renderöity HTML:

HTML-tulos

Napsauta yllä olevaa Esimerkki-painiketta ladataksesi lisää esimerkkejä editoriin.

Mikä on Markdown-katselu?

Kirjoitat README:n, dokumentaation tai blogikirjoituksen Markdownilla ja haluat nähdä miltä se oikeasti näyttää — ilman pushaamista GitHubiin. Juuri sitä varten tämä työkalu on. Liitä tai lataa Markdown, niin renderöity HTML-esikatselu ilmestyy heti oikealle. CommonMark-standardi määrittelee ydinrakenteen, ja GitHub Flavored Markdown (GFM) -määrittely lisää taulukot, tehtävälistat ja yliviivauksen. Käytitkö sitten Jekylliä, Hugoa tai kirjoitat vain dokumentaatiota, CommonMark-määrittely on viitteesi. Kaikki toimii paikallisesti — mitään sisältöä ei poistu koneeltasi.

Työkalu toimii kokonaan selaimessasi. Mitään ei lähetetä palvelimelle. Kopioi HTML tai lataa se muualle käytettäväksi. Muokkaamiseen live-esikatselulla käytä Markdown-editoria. Pelkkään muunnokseen käytä Markdown HTML:ksi -työkalua.

Miten työkalua käytetään

1

Liitä tai lataa

Kopioi Markdown ja liitä se vasempaan editoriin. Voit myös napsauttaa Lataa ja avata .md- tai .markdown-tiedoston. Esimerkki-painike lataa esimerkkidataa.

2

Katso renderöity esikatselu

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

3

Kopioi tai lataa

Käytä Kopioi HTML tai Lataa HTML saadaksesi renderöidyn tuloksen. Muotoiluun tai validointiin käytä Markdown-muotoilijaa tai Markdown-tarkistinta.

Milloin Markdown-katselusta on hyötyä

Kun sinulla on Markdown-tiedosto ja haluat nähdä miten se renderöityy avaamatta GitHubia tai erillistä sovellusta, liitä se tähän. GitHub Flavored Markdown -määrittely määrittelee taulukot ja laajennukset. Hyödyllinen Jekyllille, Hugolle, README-esikatseluihin tai vietyyn sisältöön. Muokkaamiseen käytä Markdown-editoria.

Usein kysyttyä

Onko turvallista liittää arkaluonteista sisältöä tähän?

Kyllä, täysin turvallista. Kaikki toimii JavaScriptillä selaimessasi — mitään tietoja ei lähetetä palvelimelle. Avaa selaimen Verkko-välilehti tarkistamiseksi: et näe yhtään lähtevää pyyntöä.

Mitä eroa on katseluohjelmalla, editorilla ja esikatselulla?

Kaikki kolme tarjoavat reaaliaikaisen esikatselun kirjoittaessa. Markdown-editorissa voi myös ladata sekä Markdown-lähteen että renderöidyn HTML:n. Katseluohjelma on tarkoitettu olemassa olevien tiedostojen nopeaan renderöintiin.

Tukeeko se GitHub Flavored Markdownia?

Kyllä. Suurin osa GFM-ominaisuuksista — taulukot, tehtävälistat ja yliviivaus — ovat tuettuja. GFM-määrittely laajentaa CommonMarkia ja esikatselu heijastaa sitä.

Voinko katsoa paikallisia .md-tiedostoja ilman niiden lataamista palvelimelle?

Kyllä. Napsauta Lataa avataksesi .md-tiedoston tietokoneeltasi. Sisältö luetaan ja renderöidään kokonaan selaimessa — se ei koskaan poistu laitteeltasi.

Mikä on tiedoston enimmäiskoko?

Työkalussa ei ole kiinteää rajoitusta. Käytännössä muutaman tuhannen rivin tiedostot renderöityvät ongelmitta nykyaikaisissa selaimissa. Erittäin suuret tiedostot (kymmeniä tuhansia rivejä) voivat hidastaa esikatselua.

Liittyvät työkalut

Lisätietoja: CommonMark, CommonMark-määrittely, Markdown Guide, GFM, W3C HTML, GitHub, GitHub Docs.