Sådan bruger du det
- Skriv Markdown i editoren, eller tryk på “Prøv et eksempel” for at indlæse et dokument med tabeller og en opgaveliste.
- Se forhåndsvisningen opdatere, mens du skriver. Skift til “HTML-kilde” for at se den genererede kode.
- Slå GitHub Flavored Markdown eller enkelte linjeskift til eller fra, så det passer til det sted, hvor teksten skal offentliggøres.
- Kopier HTML-koden til et CMS eller en e-mail, eller download resultatet som en .html- eller .md-fil.
Sådan fungerer det
Markdown konverteres med marked, en udbredt open source-parser, der følger CommonMark-specifikationen og, med GFM-indstillingen aktiveret, GitHub Flavored Markdown: pipe-tabeller med kolonnejustering, opgavelister, ~~gennemstregning~~ og automatiske links for bare URL'er. Fodnoter, matematik og Mermaid-diagrammer er ikke en del af disse specifikationer og vises som almindelig tekst.
Markdown kan indeholde rå HTML, og den HTML videregives uændret, ligesom de fleste Markdown-gengivere gør. Af sikkerhedshensyn bliver forhåndsvisningen aldrig indsat på denne side. Den gengives i en sandboxed-ramme, der ikke må køre scripts, indsende formularer, åbne pop op-vinduer eller få adgang til dette websted, og dens Content Security Policy blokerer scripts, eksterne stylesheets, skrifttyper og rammer. Et <script>-tag eller en onclick-attribut i din Markdown vises i HTML-kilden, men bliver aldrig udført. Links i forhåndsvisningen vises, men åbner ikke; kopier URL'en, hvis du har brug for at følge et.
Forhåndsvisningen bruger et neutralt stylesheet, der ligner almindelige README-gengivere; dit websted eller GitHub kan formatere den samme HTML anderledes. Den kopierede HTML er det rene fragment uden styles; den downloadede .html-fil tilføjer et grundlæggende stylesheet, så det ligner forhåndsvisningen. Downloadet eller kopieret HTML bliver ikke renset, så hvis den indeholder scripts, kører de, uanset hvor du indsætter eller åbner den.
Eksempler
Tjek en README, før du pusher
Indsæt README.md for at kontrollere, at tabelkolonnerne flugter, opgavelisten gengives som afkrydsningsfelter, og kodeblokkene er korrekt afgrænset, før filen bliver lagt på GitHub.
Skriv til et CMS, der accepterer HTML
Skriv et udkast til et blogindlæg i Markdown, tryk derefter på “Kopier HTML”, og indsæt <h2>, <p> og <ul>-markup i CMS'ets HTML-editor.
Linjeskift i chatstil
Tekst fra en chat-app har linjer adskilt af enkelte linjeskift. Hvis du aktiverer “Behandl enkelte linjeskift som <br>”, holdes linjerne adskilt i stedet for at blive slået sammen til ét afsnit.
Ofte stillede spørgsmål
Er det sikkert at indsætte Markdown fra en ukendt kilde?
Ja, til forhåndsvisning. Den gengivne HTML vises i en sandboxed-ramme med scripts deaktiveret, så selv et <script>-tag eller en event handler i teksten foretager sig intet her. Vær forsigtig med, hvor du indsætter den eksporterede HTML, da den ikke er renset.
Hvorfor vises mine billeder ikke?
Billeder fra andre websteder er som standard blokeret, så forhåndsvisningen ikke foretager netværksanmodninger. Slå “Indlæs billeder fra andre websteder” til for at vise dem. Relative stier som ./docs/screenshot.png kan ikke virke, fordi filerne ikke findes her.
Understøtter den fodnoter, matematik eller diagrammer?
Nej. Den understøtter CommonMark og GitHub Flavored Markdown (tabeller, opgavelister, gennemstregning, autolinks). Fodnoter, LaTeX-matematik og Mermaid-diagrammer er udvidelser, som denne forhåndsvisning gengiver som almindelig tekst.
Hvorfor starter et enkelt linjeskift ikke en ny linje?
I standard Markdown behandles et enkelt linjeskift i et afsnit som et mellemrum. Afslut linjen med to mellemrum, indsæt en tom linje, eller slå “Behandl enkelte linjeskift som <br>” til.
Privatliv
Markdown konverteres i din browser og bliver ikke uploadet eller gemt. Forhåndsvisningen indlæser intet fra internettet, medmindre du tillader billeder fra andre websteder; så hentes disse billeder direkte fra deres servere.