Prøv Markdown

Jukselapp

Hva er en Markdown-jukselapp?

En Markdown-jukselapp er en rask syntaksguide du kan bruke når du skriver dokumentasjon, README-filer, notater og nettinnhold. I stedet for å memorere hver regel kan du kopiere utprøvde mønstre for overskrifter, lister, lenker, tabeller og kodeblokker.

Denne siden er designet for hurtighet: eksemplene er kopieringsklare og basert på konvensjoner fra CommonMark og det originale Markdown-prosjektet. Fungerer utmerket med Markdown-formatereren og Markdown-editoren.

Hvis du publiserer på dokumentasjonsplattformer eller repositorier, er syntakskompatibilitet viktig. Denne hurtigreferansen inneholder vanlig brukte mønstre fra GitHubs dokumentasjon og CommonMark-kompatible editorer.

Alt fungerer i nettleseren din. Innholdet ditt forblir på enheten din når du skriver og kontrollerer syntaks.

Slik bruker du Markdown-jukselappen

Følg disse trinnene for å bla gjennom og prøve Markdown-syntaks. Hvert trinn bruker de faktiske panelene på denne siden.

Lim inn, last opp eller last inn eksempel

Skriv eller lim inn Markdown i det venstre panelet Prøv Markdown eller klikk på Last opp for å laste inn en fil. Klikk på Eksempel for å se et eksempel på API-dokumentasjon. Det høyre panelet Jukselapp viser grunnleggende syntaks, kode, tabeller og oppgavelister.

Kontroller og øv

Bruk jukselappen for overskrifter, utheving, lenker, kodeblokker og tabeller. Kopier mønstre til det venstre panelet for å prøve dem. Kompatibel med CommonMark og GitHub.

Kopier eller last ned

Klikk på Kopier eller Last ned for å lagre jukselappen. Bruk Tøm for å starte på nytt. Alle operasjoner skjer i nettleseren.

Pålitelige Markdown-kilder

Autoritative kilder brukt av utviklere, tekniske skribenter og dokumentasjonsteam:

Slik bruker du disse kildene

Bruk CommonMark som grunnlag, kontroller plattformspesifikk oppførsel i GitHub/GitLab-dokumentasjonen og verifiser det renderte resultatet før publisering.

Vanlige brukstilfeller

Skrive README

Bruk hurtigsyntakseksempler når du skriver prosjektdokumentasjon i repositorier.

Tekniske notater

Sikre konsekvent formatering av designdokumenter, hendelsesnotater og arkitekturoppdateringer.

Teamintroduksjon

Nye teammedlemmer kan kopiere fungerende syntaks i stedet for å lære hver regel fra bunnen av.

Sjekklister

Opprett oppgavelister for utrullinger, QA og utgivelser med korrekt Markdown-sjekklisteformatering.

Ofte stilte spørsmål

Er dette basert på standard-Markdown?

Ja. Guiden følger allment brukt CommonMark-kompatibel syntaks. For formelle regler, besøk CommonMark-spesifikasjonen.

Kan jeg kopiere hele jukselappen?

Ja. Bruk kopieringsknappen for umiddelbart å kopiere hele guiden til utklippstavlen.

Kan jeg laste ned som fil?

Ja. Bruk nedlastingsknappen for å lagre jukselappen som en .md-fil.

Forlater teksten min nettleseren?

Nei. Alt kjører lokalt i nettleseren din, akkurat som andre Markdown-verktøy.

Kan jeg konvertere Markdown til HTML her?

Ja. Bruk Markdown til HTML-verktøyet når du trenger å konvertere. For HTML-semantikk, se MDN HTML-dokumentasjonen.

Kan jeg rydde opp i rotete Markdown?

Ja. Bruk Markdown-formatereren for å fikse mellomrom og struktur.

Andre Markdown-verktøy

Bruk disse verktøyene sammen med jukselappen i skrive-, formaterings- og konverteringsarbeidsflyter:

Markdown-jukselapp