Prova Markdown

Fusklapp

Vad är en Markdown-fusklapp?

En Markdown-fusklapp är en snabb syntaxguide som du kan använda när du skriver dokumentation, README-filer, anteckningar och webbinnehåll. Istället för att memorera varje regel kan du kopiera beprövade mönster för rubriker, listor, länkar, tabeller och kodblock.

Den här sidan är utformad för snabbhet: exemplen är kopieringsklara och baserade på konventioner från CommonMark och det ursprungliga Markdown-projektet. Fungerar utmärkt med Markdown-formateraren och Markdown-redigeraren.

Om du publicerar på dokumentationsplattformar eller förvar är syntaxkompatibilitet viktig. Den här snabbreferensen innehåller vanligt använda mönster från GitHubs dokumentation och CommonMark-kompatibla redigerare.

Allt fungerar i din webbläsare. Ditt innehåll stannar på din enhet när du skriver och kontrollerar syntax.

Hur man använder Markdown-fusklappen

Följ dessa steg för att bläddra 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

Skriv eller klistra in Markdown i den vänstra panelen Prova Markdown eller klicka på Ladda upp för att läsa in en fil. Klicka på Exempel för att se ett exempel på API-dokumentation. Den högra panelen Fusklapp visar grundläggande syntax, kod, tabeller och uppgiftslistor.

Kontrollera och öva

Använd fusklappen för rubriker, betoning, länkar, kodblock och tabeller. Kopiera mönster till den vänstra panelen för att prova dem. Kompatibel med CommonMark och GitHub.

Kopiera eller ladda ner

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

Betrodda Markdown-källor

Auktoritativa källor som används av utvecklare, tekniska skribenter och dokumentationsteam:

Hur man använder dessa källor

Använd CommonMark som grund, kontrollera plattformsspecifikt beteende i GitHub/GitLab-dokumentationen och verifiera det renderade resultatet innan publicering.

Vanliga användningsfall

Skriva README

Använd snabbsyntaxexempel när du skriver projektdokumentation i förvar.

Tekniska anteckningar

Säkerställ konsekvent formatering av designdokument, incidentanteckningar och arkitekturuppdateringar.

Introduktion av team

Nya teammedlemmar kan kopiera fungerande syntax istället för att lära sig varje regel från grunden.

Checklistor

Skapa uppgiftslistor för driftsättningar, QA och releaser med korrekt Markdown-checklistformatering.

Vanliga frågor

Är detta baserat på standard-Markdown?

Ja. Guiden följer allmänt använd CommonMark-kompatibel syntax. För formella regler, besök CommonMark-specifikationen.

Kan jag kopiera hela fusklappen?

Ja. Använd kopieringsknappen för att omedelbart kopiera hela guiden till urklipp.

Kan jag ladda ner som fil?

Ja. Använd nedladdningsknappen för att spara fusklappen som en .md-fil.

Lämnar min text webbläsaren?

Nej. Allt körs lokalt i din webbläsare, precis som andra Markdown-verktyg.

Kan jag konvertera Markdown till HTML här?

Ja. Använd Markdown till HTML-verktyget när du behöver konvertera. För HTML-semantik, se MDN HTML-dokumentationen.

Kan jag städa upp rörig Markdown?

Ja. Använd Markdown-formateraren för att fixa blanksteg och struktur.

Andra Markdown-verktyg

Använd dessa verktyg tillsammans med fusklappen i skriv-, formaterings- och konverteringsarbetsflöden:

Markdown-fusklapp