Prøv Markdown

Snydeark

Hvad er et Markdown-snydeark?

Et Markdown-snydeark er en hurtig syntaksguide, du kan bruge, når du skriver dokumentation, README-filer, noter og webindhold. I stedet for at huske hver regel kan du kopiere gennemprøvede mønstre til overskrifter, lister, links, tabeller og kodeblokke.

Denne side er designet til hurtighed: eksemplerne er kopieringsklare og baseret på konventioner fra CommonMark og det originale Markdown-projekt. Fungerer fremragende med Markdown-formateren og Markdown-editoren.

Hvis du publicerer på dokumentationsplatforme eller repositories, er syntakskompatibilitet vigtig. Denne hurtigreference indeholder almindeligt brugte mønstre fra GitHubs dokumentation og CommonMark-kompatible editorer.

Alt fungerer i din browser. Dit indhold forbliver på din enhed, når du skriver og kontrollerer syntaks.

Sådan bruger du Markdown-snydeark

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

Indsæt, upload eller indlæs eksempel

Skriv eller indsæt Markdown i det venstre panel Prøv Markdown eller klik på Upload for at indlæse en fil. Klik på Eksempel for at se et eksempel på API-dokumentation. Det højre panel Snydeark viser grundlæggende syntaks, kode, tabeller og opgavelister.

Kontroller og øv

Brug snydearket til overskrifter, betoning, links, kodeblokke og tabeller. Kopier mønstre til det venstre panel for at prøve dem. Kompatibel med CommonMark og GitHub.

Kopier eller download

Klik på Kopier eller Download for at gemme snydearket. Brug Ryd for at starte forfra. Alle operationer sker i browseren.

Betroede Markdown-kilder

Autoritative kilder brugt af udviklere, tekniske skribenter og dokumentationsteams:

Sådan bruger du disse kilder

Brug CommonMark som grundlag, kontroller platformspecifik adfærd i GitHub/GitLab-dokumentationen og verificer det renderede resultat før publicering.

Almindelige anvendelsestilfælde

Skrive README

Brug hurtigsyntakseksempler, når du skriver projektdokumentation i repositories.

Tekniske noter

Sikr konsekvent formatering af designdokumenter, hændelsesnoter og arkitekturopdateringer.

Teamintroduktion

Nye teammedlemmer kan kopiere fungerende syntaks i stedet for at lære hver regel fra bunden.

Tjeklister

Opret opgavelister til udrulninger, QA og releases med korrekt Markdown-tjeklisteformatering.

Ofte stillede spørgsmål

Er dette baseret på standard-Markdown?

Ja. Guiden følger almindeligt brugt CommonMark-kompatibel syntaks. For formelle regler, besøg CommonMark-specifikationen.

Kan jeg kopiere hele snydearket?

Ja. Brug kopieringsknappen for øjeblikkeligt at kopiere hele guiden til udklipsholder.

Kan jeg downloade som fil?

Ja. Brug downloadknappen for at gemme snydearket som en .md-fil.

Forlader min tekst browseren?

Nej. Alt kører lokalt i din browser, ligesom andre Markdown-værktøjer.

Kan jeg konvertere Markdown til HTML her?

Ja. Brug Markdown til HTML-værktøjet, når du skal konvertere. For HTML-semantik, se MDN HTML-dokumentationen.

Kan jeg rydde op i rodet Markdown?

Ja. Brug Markdown-formateren for at rette mellemrum og struktur.

Andre Markdown-værktøjer

Brug disse værktøjer sammen med snydearket i skrive-, formaterings- og konverteringsarbejdsgange:

Markdown-snydeark