Markdown-utkast

Live-förhandsgranskning

Vad är Markdown-förhandsgranskning?

Markdown-förhandsgranskning är ett realtidsrenderingsverktyg som visar exakt hur Markdown-källkoden kommer att se ut när den konverteras till HTML. Med ett delat panelgränssnitt skriver du rå Markdown på vänster sida medan höger sida visar renderad utdata omedelbart. Denna omedelbara visuella återkoppling eliminerar gissningar om formatering — du kan se hur rubriker ser ut, om länkar fungerar, hur kodblock renderas och om tabellsyntaxen är korrekt.

CommonMark är standard-Markdown-specifikationen som följs av de flesta förhandsgranskningsverktyg och säkerställer konsekvent rendering mellan plattformar. Det här verktyget implementerar CommonMark-kompatibel tolkning. För GitHub-specifika funktioner som uppgiftslistor, genomstrykning och autolänkar inkluderar förhandsgranskningen även stöd för GitHub Flavored Markdown-tillägg.

Förhandsgranskningsverktyg är ovärderliga för alla innehållsskapare som arbetar med Markdown. Tekniska skribenter kan validera komplexa kapslade listor och kodblockformatering. Öppen källkodsunderhållare kan säkerställa att funktionstabeller renderas korrekt. Utvecklare kan formatera commit-meddelanden, pull request-beskrivningar och issue-kommentarer innan inlämning.

Hur man använder Markdown-förhandsgranskning

Följ dessa steg för att förhandsgranska Markdown som HTML i realtid. Varje steg använder de faktiska knapparna och panelerna på den här sidan.

1

Klistra in, ladda upp eller läs in exempel

Skriv eller klistra in Markdown i den vänstra panelen Markdown-utkast, eller klicka på Ladda upp för att läsa in en .md-fil. Klicka på Exempel för att se exempel på API-dokumentation. Stöder CommonMark och GFM (tabeller, uppgiftslistor, kodblock).

2

Visa live-förhandsgranskning

Den högra panelen Live-förhandsgranskning uppdateras medan du skriver. Visa renderade rubriker, listor, tabeller och kodblock. Ingen fördröjning — omedelbar återkoppling.

3

Kopiera eller ladda ner HTML

Klicka på Kopiera HTML eller Ladda ner HTML för att använda utdatan. Använd Rensa för att börja om. All bearbetning sker i din webbläsare.

När du verkligen skulle använda det

Skriva och redigera dokumentation

GitHub-förvar, ReadTheDocs-projekt och dokumentationssajter byggda med MkDocs eller Hugo använder alla Markdown. Förhandsgranskningsverktyg låter dig skapa och förfina dokumentation utan att vänta på byggen eller driftsättningar.

Utkast till blogginlägg och artiklar

Bloggplattformar som Jekyll, Hugo, 11ty och Ghost accepterar Markdown för innehåll. Skriv och formatera ditt inlägg i förhandsgranskningsverktyget, kontrollera typografi och betoning och kopiera sedan till din bloggplattform.

Skriva issues och PR på GitHub

När du skriver detaljerade issues eller pull request-beskrivningar på GitHub låter förhandsgranskningsverktyg dig formatera ditt meddelande perfekt. Kontrollera att tabeller och kodblock är korrekta innan inlämning.

Skapa release-anteckningar och changelogs

Programvarureleaser kräver tydliga, välformaterade anteckningar. Använd Markdown-förhandsgranskning för att skriva changelogs med korrekt formatering, versionsrubriker, funktionslistor och varningar om brytande ändringar.

Vanliga frågor (FAQ)

Visar förhandsgranskningen exakt hur mitt innehåll kommer att renderas överallt?

Förhandsgranskningen använder CommonMark-kompatibel tolkning plus GitHub Flavored Markdown-tillägg, vilket korrekt representerar hur innehållet kommer att se ut på de flesta moderna plattformar. Vissa plattformar har dock anpassade CSS-stilar eller ytterligare tillägg. Kontrollera målplattformens dokumentation om du behöver exakt visuell matchning.

Vilka Markdown-tillägg stöds?

Den här förhandsgranskningen stöder CommonMark-kärnssyntax plus GitHub Flavored Markdown-tillägg: tabeller, uppgiftslistor, genomstrykning (~~text~~), autolänkar och omnämningssyntax.

Kan jag kopiera den genererade HTML?

Ja. Klicka på "Kopiera HTML" för att kopiera den renderade HTML-utdatan till urklipp. Du kan sedan klistra in den i en HTML-redigerare, e-postklient eller webbformulär som accepterar HTML.

Är specialtecken korrekt escapade i utdatan?

Ja. Tolkaren escapar automatiskt specialtecken i HTML (&, <, >, ", ') i textinnehåll, vilket förhindrar injektionsattacker och renderingsfel.

Hur hanterar verktyget radbrytningar?

Verktyget följer CommonMark-reglerna: ett enstaka radbrytning i källan blir ett blanksteg i utdatan. För att skapa en verklig radbrytning (<br>), använd två blanksteg i slutet av raden följt av ett nyradstecken, eller använd ett bakstreck före nyradstecknet.

Kan jag inkludera rå HTML i min Markdown?

Ja. Markdown tillåter råa HTML-block och inline-HTML. Om du skriver HTML direkt i din Markdown inkluderas det oförändrat i utdatan. Detta är användbart för funktioner som Markdown inte stöder inbyggt.

Relaterade verktyg