tigtools

Markdown-esikatselu

Kirjoita tai liitä Markdown vasemmalle ja näet sen renderöitynä vieressä. Esikatselu on eristetty, joten tekstissä olevat skriptit eivät koskaan suoritu.

Toimii selaimessasi Ei rekisteröitymistä

Näytä

Käyttöohje

  1. Kirjoita Markdownia editorissa tai paina ”Kokeile esimerkkiä”, niin saat asiakirjan, jossa on taulukoita ja tehtäväluettelo.
  2. Katso, miten esikatselu päivittyy kirjoittaessasi. Vaihda ”HTML-lähdekoodi”-näkymään nähdäksesi luodun merkintäkoodin.
  3. Ota GitHub Flavored Markdown tai yksittäiset rivinvaihdot käyttöön tai pois käytöstä sen mukaan, missä teksti julkaistaan.
  4. Kopioi HTML sisällönhallintajärjestelmään tai sähköpostiin tai lataa tulos .html- tai .md-tiedostona.

Näin se toimii

Markdown muunnetaan marked-jäsentimellä, joka on laajalti käytetty avoimen lähdekoodin jäsennin. Se noudattaa CommonMark-määritystä ja, kun GFM-asetus on käytössä, GitHub Flavored Markdown -merkintää: putkitaulukot sarakkeiden tasauksella, tehtäväluettelot, ~~yliviivaus~~ ja automaattiset linkit paljaille URL-osoitteille. Alaviitteet, matematiikka ja Mermaid-kaaviot eivät kuulu näihin määrityksiin, ja ne näytetään tavallisena tekstinä.

Markdown voi sisältää raakaa HTML:ää, ja tämä HTML välitetään muuttumattomana, kuten useimmat Markdown-renderöijät tekevät. Turvallisuutesi vuoksi esikatselua ei koskaan lisätä tälle sivulle. Se renderöidään hiekkalaatikkoon eristetyssä kehyksessä, joka ei saa suorittaa komentosarjoja, lähettää lomakkeita, avata ponnahdusikkunoita tai käyttää tätä sivustoa, ja sen sisällön suojauskäytäntö estää komentosarjat, ulkoiset tyylitiedostot, fontit ja kehykset. <script>-tunniste tai onclick-attribuutti Markdownissasi näkyy HTML-lähteessä, mutta sitä ei koskaan suoriteta. Esikatselun linkit näytetään, mutta ne eivät avaudu; kopioi URL-osoite, jos haluat seurata jotakin.

Esikatselu käyttää neutraalia tyylitiedostoa, joka muistuttaa tavallisia README-renderöijiä. Sivustosi tai GitHub voi muotoilla saman HTML:n eri tavalla. Kopioitu HTML on pelkkä fragmentti ilman tyylejä; ladattu .html-tiedosto lisää perustyylit, joten se näyttää esikatselulta. Ladattua tai kopioitua HTML:ää ei puhdisteta, joten jos se sisältää komentosarjoja, ne suoritetaan siellä, mihin liität tai avaat sen.

Esimerkit

README-tiedoston tarkistus ennen pushausta

Liitä README.md tarkistaaksesi, että taulukon sarakkeet ovat kohdallaan, tehtävälista näkyy valintaruutuina ja koodilohkot on rajattu oikein, ennen kuin tiedosto menee GitHubiin.

Kirjoittaminen HTML:ää hyväksyvään CMS:ään

Kirjoita blogikirjoitus Markdownilla, paina sitten ”Kopioi HTML” ja liitä <h2>-, <p>- ja <ul>-merkinnät CMS:n HTML-editoriin.

Chat-tyyliset rivinvaihdot

Chat-sovelluksesta tulevassa tekstissä rivit on erotettu yksittäisillä rivinvaihdoilla. Kun kytket asetuksen ”Käsittele yksittäiset rivinvaihdot <br>-elementteinä” päälle, rivit pysyvät erillään eivätkä yhdisty yhdeksi kappaleeksi.

Usein kysytyt kysymykset

Onko turvallista liittää Markdownia tuntemattomasta lähteestä?

Kyllä, esikatselussa. Renderöity HTML näytetään hiekkalaatikoidussa kehyksessä, jossa skriptit on poistettu käytöstä, joten edes <script>-tagi tai tapahtumankäsittelijä tekstissä ei tee täällä mitään. Ole varovainen, mihin liität viedyn HTML:n, koska sitä ei ole puhdistettu.

Miksi kuvani eivät näy?

Muiden verkkosivustojen kuvat on oletuksena estetty, jotta esikatselu ei tee verkkopyyntöjä. Ota käyttöön ”Lataa kuvat muilta verkkosivustoilta”, niin ne näytetään. Suhteelliset polut, kuten ./docs/screenshot.png, eivät toimi, koska tiedostot eivät ole täällä.

Tukeeko se alaviitteitä, matematiikkaa tai kaavioita?

Ei. Se tukee CommonMarkia ja GitHub Flavored Markdownia (taulukot, tehtäväluettelot, yliviivaus, automaattiset linkit). Alaviitteet, LaTeX-matematiikka ja Mermaid-kaaviot ovat laajennuksia, jotka tämä esikatselu jättää tavalliseksi tekstiksi.

Miksi yksittäinen rivinvaihto ei aloita uutta riviä?

Tavallisessa Markdownissa yksi rivinvaihto kappaleen sisällä käsitellään välilyöntinä. Päätä rivi kahteen välilyöntiin, jätä tyhjä rivi tai ota käyttöön ”Käsittele yksittäiset rivinvaihdot <br>”.

Tietosuoja

Markdown muunnetaan selaimessasi, eikä sitä ladata palvelimelle tai tallenneta. Esikatselu ei lataa mitään internetistä, ellet salli kuvia muilta verkkosivustoilta; tällöin kuvat pyydetään suoraan niiden palvelimilta.