Prova syntax

Syntaxreferens

Vad är Markdown-syntax?

Markdown är ett lättviktigt märkspråk skapat av John Gruber 2004. Det använder enkla symboler och tecken för att formatera text, vilket gör det enkelt att skriva innehåll som konverteras till HTML utan att se rörigt ut i råformat. Markdown har blivit standard för dokumentation, README-filer, bloggar och allt innehåll som behöver enkel, läsbar formatering.

CommonMark är den mest brett accepterade Markdown-specifikationen som definierar hur tolkar ska tolka syntax. Genom att lära dig CommonMark-kompatibel syntax kommer ditt innehåll att renderas konsekvent på GitHub, GitLab, Discord, Slack, Reddit, Stack Overflow och dussintals andra plattformar. John Grubers ursprungliga Markdown-specifikation förblir grundläggande, medan tillägg som GitHub Flavored Markdown lägger till funktioner som uppgiftslistor, genomstrykning och tabeller.

Modernt Markdown finns i flera varianter anpassade för specifika plattformar. GitHub Flavored Markdown (GFM) lägger till tabeller, kryssrutor och autolänkar. GitLab Markdown stöder liknande tillägg plus diagram. Att lära sig CommonMarks kärnssyntax ger en bärbar grund som fungerar överallt.

Hur man använder Markdown-syntaxguiden

Följ dessa steg för att lära dig och prova Markdown-syntax. Varje steg använder de faktiska panelerna på den här sidan.

Klistra in, ladda upp eller läs in exempel

Klistra in Markdown i den vänstra panelen Prova syntax, 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. Den högra panelen Syntaxreferens visar CommonMark- och GFM-mönster.

Öva och konsultera

Använd referensen för rubriker, betoning, listor, länkar, tabeller, kodblock. Kopiera exempel till den vänstra panelen för att prova dem. Täcker CommonMark plus GitHub Flavored Markdown-tillägg.

Kopiera eller ladda ner

Klicka på Kopiera eller Ladda ner för att spara referensen. Använd Rensa för att börja om. All bearbetning sker i webbläsaren.

När du verkligen skulle använda det

Skriva dokumentation

Teknisk dokumentation, API-referensguider och programvarudokumentation skrivs nästan universellt i Markdown. Python Docs, Node.js-guider och de flesta öppen källkodsprojekt använder Markdown för sina dokumentationssajter. En syntaxreferens håller dig produktiv när du skriver komplex dokumentation.

README och projektfiler

Varje GitHub-projekt har en README.md-fil som beskriver projektet, användning, installation och bidragsriktlinjer. Dessa filer är helt skrivna i Markdown och är ofta det första användarna ser.

Skapa och publicera innehåll

Bloggplattformar som Jekyll, Hugo och Ghost accepterar Markdown för innehåll. Medium-liknande plattformar och statiska webbplatsgeneratorer använder Markdown som primärt indataformat. Att känna till syntax hjälper dig skriva snabbare och bibehålla konsekvent formatering.

Samarbetskommunikation

Slack, Discord, GitHub-issues, pull request-kommentarer och foruminlägg stöder alla Markdown-formatering. Under kodgranskningar, felrapportering eller teamsamtal låter Markdown dig tydligt formatera ditt meddelande utan att avbryta konversationsflödet.

Vanliga frågor (FAQ)

Kan jag använda HTML inuti Markdown?

Ja, Markdown tillåter blandning av rå HTML. Om Markdown inte stöder något du behöver kan du skriva HTML direkt och det passerar igenom till utdatan. Enligt CommonMark-specifikationen erkänns HTML-block och inline-HTML och passeras omodifierade. Använd sparsamt.

Vad är skillnaden mellan asterisker och understreck för betoning?

Funktionellt identiska i CommonMark — *text* och _text_ producerar båda kursiv, **text** och __text__ producerar båda fetstil. Valet är stilistiskt. Många team föredrar asterisker för konsekvens och eftersom de är lättare att skriva på de flesta tangentbord.

Hur fungerar radbrytningar i Markdown?

Detta är en vanlig förvirringskälla. En enskild radmatning i källan behandlas som ett blanksteg. För att skapa en verklig radbrytning (<br> i HTML), lägg till två blanksteg i slutet av raden innan du trycker Enter, eller använd ett bakstreck före radmatningen. För styckebrytningar, använd en tom rad.

Stöds tabeller överallt i Markdown?

Nej. Tabeller är en del av GitHub Flavored Markdown och andra tillägg, men inte CommonMark-standarden. De flesta moderna plattformar (GitHub, GitLab, Discord) stöder dem, men vissa äldre Markdown-tolkar känner inte igen pipe-syntaxen.

Hur escapar jag specialtecken?

Använd ett bakstreck (\) före tecken med speciell betydelse i Markdown: bakstreck (\), backtick (`), asterisk (*), understreck (_), klammerparentes ({}), hakparentes ([]), parenteser (()), nummertecken (#), plus (+), minus (-), punkt (.) och utropstecken (!). Till exempel renderar \*inte kursiv\* asteriskerna bokstavligt.

Vad är det bästa sättet att formatera kod i Markdown?

För inline-kod, använd enstaka backtick: `kod här`. För kodblock, använd trippla backtick med en valfri språktagg (```javascript) för syntaxmarkering. Undvik att indraga kod som ett kodblock — inhägnade block är tydligare och mer bärbara.

Markdown-syntaxguide