Prøv syntaks

Syntaksreference

Hvad er Markdown-syntaks?

Markdown er et letvægts markup-sprog skabt af John Gruber i 2004. Det bruger simple symboler og tegn til at formatere tekst, hvilket gør det nemt at skrive indhold, der konverteres til HTML uden at se rodet ud i råformat. Markdown er blevet standard for dokumentation, README-filer, blogs og alt indhold, der har brug for enkel, læsbar formatering.

CommonMark er den mest bredt accepterede Markdown-specifikation, der definerer, hvordan parsere skal fortolke syntaksen. Ved at lære CommonMark-kompatibel syntaks vil dit indhold renderes konsistent på GitHub, GitLab, Discord, Slack, Reddit, Stack Overflow og mange andre platforme. John Grubers oprindelige Markdown-specifikation forbliver grundlæggende, mens udvidelser som GitHub Flavored Markdown tilføjer funktioner som opgavelister, gennemstregning og tabeller.

Moderne Markdown findes i flere varianter tilpasset specifikke platforme. GitHub Flavored Markdown (GFM) tilføjer tabeller, afkrydsningsfelter og autolinks. GitLab Markdown understøtter lignende udvidelser plus diagrammer. At lære CommonMarks kernesyntaks giver et portabelt grundlag, der fungerer overalt.

Sådan bruger du Markdown-syntaksguiden

Følg disse trin for at lære og prøve Markdown-syntaks. Hvert trin bruger de faktiske paneler på denne side.

Indsæt, upload eller indlæs eksempel

Indsæt Markdown i det venstre panel Prøv syntaks, eller klik på Upload for at indlæse en .md-fil. Klik på Eksempel for at se eksempel-API-dokumentation. Det højre panel Syntaksreference viser CommonMark- og GFM-mønstre.

Øv og konsultér

Brug referencen til overskrifter, fremhævning, lister, links, tabeller, kodeblokke. Kopiér eksempler til venstre panel for at prøve dem. Dækker CommonMark plus GitHub Flavored Markdown-udvidelser.

Kopiér eller download

Klik på Kopiér eller Download for at gemme referencen. Brug Ryd for at starte forfra. Al behandling kører i browseren.

Hvornår du faktisk ville bruge det

Skrivning af dokumentation

Teknisk dokumentation, API-referenceguider og softwaredokumentation skrives næsten universelt i Markdown. Python Docs, Node.js-guider og de fleste open source-projekter bruger Markdown til deres dokumentationssider. En syntaksreference holder dig produktiv, når du skriver kompleks dokumentation.

README og projektfiler

Hvert GitHub-projekt har en README.md-fil, der beskriver projektet, brug, installation og bidragsretningslinjer. Disse filer er helt skrevet i Markdown og er ofte det første, brugere ser.

Indholdsoprettelse og publicering

Blogplatforme som Jekyll, Hugo og Ghost accepterer Markdown til indhold. Medium-lignende platforme og statiske site-generatorer bruger alle Markdown som deres primære inputformat. At kende syntaks hjælper dig med at skrive hurtigere og opretholde konsistent formatering.

Samarbejdskommunikation

Slack, Discord, GitHub-issues, pull request-kommentarer og forumindlæg understøtter alle Markdown-formatering. Under kodegennemgange, fejlrapportering eller teamsamtaler lader Markdown dig formatere din besked tydeligt uden at afbryde samtaleflowet.

Ofte stillede spørgsmål (FAQ)

Kan jeg bruge HTML inde i Markdown?

Ja, Markdown tillader blanding af rå HTML. Hvis Markdown ikke understøtter noget, du har brug for, kan du skrive HTML direkte, og det passerer igennem til outputtet. Ifølge CommonMark-specifikationen genkendes HTML-blokke og inline-HTML og passerer umodificerede. Brug det sparsomt.

Hvad er forskellen mellem asterisker og understreger til fremhævning?

Funktionelt identiske i CommonMark — *tekst* og _tekst_ producerer begge kursiv, **tekst** og __tekst__ producerer begge fed. Valget er stilistisk. Mange teams foretrækker asterisker for konsistens og fordi de er nemmere at skrive på de fleste tastaturer.

Hvordan fungerer linjeskift i Markdown?

Dette er en almindelig forvirring. Et enkelt linjeskift i kilden behandles som et mellemrum. For at oprette et ægte linjeskift (<br> i HTML), tilføj to mellemrum i slutningen af linjen, før du trykker Enter, eller brug en omvendt skråstreg før linjeskiftet. For afsnitsskift, brug en tom linje.

Understøttes tabeller overalt i Markdown?

Nej. Tabeller er en del af GitHub Flavored Markdown og andre udvidelser, men ikke CommonMark-standarden. De fleste moderne platforme (GitHub, GitLab, Discord) understøtter dem, men nogle ældre Markdown-parsere genkender ikke pipe-syntaksen.

Hvordan escaper jeg specialtegn?

Brug en omvendt skråstreg (\) før tegn med speciel betydning i Markdown: omvendt skråstreg (\), backtick (`), asterisk (*), understregning (_), krøllet parentes ({}), kantet parentes ([]), parentes (()), nummertegn (#), plus (+), minus (-), punktum (.) og udråbstegn (!). For eksempel renderer \*ikke kursiv\* asteriskerne bogstaveligt.

Hvad er den bedste måde at formatere kode i Markdown?

Til inline-kode, brug enkelt backtick: `kode her`. Til kodeblokke, brug tre backticks med et valgfrit sprogtag (```javascript) til syntaksfremhævning. Undgå at indrykke kode som en kodeblok — indhegnede blokke er tydeligere og mere portable.

Markdown-syntaksguide