Mikä on Markteewn Esikatselu?
Markdown-esikatselu muuttaa Markdown-muotoilukieleen kirjoitetun tekstin HTML:ksi reaaliaikaisesti. Se on ideaalinen työkalu dokumenttien, README-tiedostojen ja blogipostien kirjoittamiseen.
Milloin käyttää tätä laskuria
- GitHub- tai GitLab README:n kirjoittaminen ja muotoilun tarkistaminen ennen commitointia
- Markdown-julkaisun luonnostelu blogialustalle, dokumentaatiopalstalle tai wikille
- Markdown-sähköpostin tai chat-viestin renderöinnin tarkistaminen ennen lähettämistä
- Markdown-syntaksin oppiminen kokeilemalla erilaisia muotoiluja ja näkemällä välittömät tulokset
- Lyhyen Markdown-palasen muunto HTML:ksi liittämistä varten CMS:ään tai sähköpostimalliin
- Markdown-dokumentin virheenjäljitys jossa osa muotoilusta ei näy odotetulla tavalla
Vaiheet:
- Kirjoita tai liitä Markdownisi vasempaan paneeliin.
- Katso renderöity HTML-esikatselu päivittyvän heti oikealla.
- Säädä syntaksiänesi kunnes esikatselu vastaa toivomaasi tulosta.
- Kopioi valmis Markdown-lähde kunnes olet tyytyväinen tulokseen.
Kaava
Markdown-merkinnät:
# Otsikko 1
## Otsikko 2
**Lihavoitu**
*Kурссивöity*
`koodi`
- Lista
1. Numeroidut
> lainaus
[Linkki](url)
Käyttötapaukset
- GitHub- tai GitLab README:n esikatselu ennen commitointia
- Muotoiltujen viestien luonnostelu Slackiin, Discordin tai muihin Markdown-tukeviin chateihin
- Blogikirjoituksen tai dokumentaation muotoilun tarkistaminen ennen julkaisua
- Markdown-syntaksin oppiminen kokeilemalla ja näkemällä välittömät tulokset
- Lyhyen Markdown-palasen nopea muuntos HTML:ksi liittämistä varten
Keskeiset hyödyt
- Näe Markdownisi renderöityvän heti, rinnakkain lähdekoodin kanssa
- Havaitse syntaksivirheet ennen julkaisua missä tahansa
- Toimii kokonaan offline-selaimessasi — mitään ei ladata
- Ilmainen, ei rekisteröintiä, ei tiedostokokorajoja normaalikäytössä
Ammattilaisen vinkit
- Lisää tyhjä rivi luetteloitten ja koodilohkojen ennen ja jälkeen varmimmaksi renderöinniksi eri Markdown-jäsentimillä
- Käytä kahdesta tähestä lihavointiin ja yhtä tähteä (tai alaviivaa) kursiiviin välttääksesi epäselvyyden
- Esikatsele tässä työkalussa ensin ja tarkista sitten kohdealusta (GitHub, Slack jne.), koska jotkut tukevat lisäsyntaksia kuten taulukoita
- Pidä otsikot peräkkäisinä (älä hyppää # → ###) parempaa dokumenttirakennetta ja saavutettavuutta varten
Yleisiä vältettäviä virheitä
- Unohdetaan tyhjä rivi kappaleen ja sitä seuraavan luettelon välillä
- Puuttuva välilyönti # -merkkien jälkeen otsikoissa, mikä estää niiden renderöitymisen
- Koodiaidan (```) jättäminen sulkematta, jolloin koko loppudokumentti muuttuu koodiksi
- Käytetään yhtä tähteä lihavoinnin sijaan kahdesta tähestä, mikä tuottaa kursiivin
Keskeiset käsitteet selitettynä
- CommonMark: Standardoitu Markdown-syntaksimäärittely, suunniteltu epäjohdonmukaisuuksien vähentämiseksi
- GFM: GitHub-Flavored Markdown, laajennettu murre joka tukee taulukoita ja tehtävalistoja
- Koodiaita: Kolmella takaisinmerkillä (```) rajattulohko monirivikoodin muotoiluun
- Sisäkkäinen muotoilu: Muotoilu yhdellä rivillä, kuten *kursiivi* tai `koodi`, toisin kuin lohko-
Liittyvät käsitteet
Esimerkki
Kirjoita vasempaan paneeliin Markdown ja näe HTML-tulos oikealla heti.
Tulosten tulkinta
Kokeile eri muotoiluja: otsikoita, lihavoointia, listoja, koodilohkoja ja linkkejä. Esikatselu päivittyy automaattisesti.