Prøv syntaks

Syntaksreferanse

Hva er Markdown-syntaks?

Markdown er et lettvekts markup-språk laget av John Gruber i 2004. Det bruker enkle symboler og tegn for å formatere tekst, noe som gjør det enkelt å skrive innhold som konverteres til HTML uten å se rotete ut i råformat. Markdown har blitt standard for dokumentasjon, README-filer, blogger og alt innhold som trenger enkel, lesbar formatering.

CommonMark er den mest bredt aksepterte Markdown-spesifikasjonen som definerer hvordan parsere skal tolke syntaksen. Ved å lære CommonMark-kompatibel syntaks vil innholdet ditt renderes konsistent på GitHub, GitLab, Discord, Slack, Reddit, Stack Overflow og mange andre plattformer. John Grubers opprinnelige Markdown-spesifikasjon forblir grunnleggende, mens utvidelser som GitHub Flavored Markdown legger til funksjoner som oppgavelister, gjennomstreking og tabeller.

Moderne Markdown finnes i flere varianter tilpasset spesifikke plattformer. GitHub Flavored Markdown (GFM) legger til tabeller, avkrysningsbokser og autolenker. GitLab Markdown støtter lignende utvidelser pluss diagrammer. Å lære CommonMarks kjernesyntaks gir et portabelt grunnlag som fungerer overalt.

Slik bruker du Markdown-syntaksguiden

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

Lim inn, last opp eller last inn eksempel

Lim inn Markdown i det venstre panelet Prøv syntaks, eller klikk på Last opp for å laste inn en .md-fil. Klikk på Eksempel for å se eksempel-API-dokumentasjon. Det høyre panelet Syntaksreferanse viser CommonMark- og GFM-mønstre.

Øv og konsulter

Bruk referansen for overskrifter, utheving, lister, lenker, tabeller, kodeblokker. Kopier eksempler til det venstre panelet for å prøve dem. Dekker CommonMark pluss GitHub Flavored Markdown-utvidelser.

Kopier eller last ned

Klikk på Kopier eller Last ned for å lagre referansen. Bruk Tøm for å starte på nytt. All behandling skjer i nettleseren.

Når du faktisk ville brukt dette

Skriving av dokumentasjon

Teknisk dokumentasjon, API-referanseguider og programvaredokumentasjon skrives nesten universelt i Markdown. Python Docs, Node.js-guider og de fleste åpen kildekode-prosjekter bruker Markdown for sine dokumentasjonssider. En syntaksreferanse holder deg produktiv når du skriver kompleks dokumentasjon.

README og prosjektfiler

Hvert GitHub-prosjekt har en README.md-fil som beskriver prosjektet, bruk, installasjon og bidragsretningslinjer. Disse filene er helt skrevet i Markdown og er ofte det første brukere ser.

Innholdsskaping og publisering

Bloggplattformer som Jekyll, Hugo og Ghost aksepterer Markdown for innhold. Medium-lignende plattformer og statiske nettstedsgeneratorer bruker alle Markdown som sitt primære inngangsformat. Å kjenne til syntaks hjelper deg med å skrive raskere og opprettholde konsistent formatering.

Samarbeidskommunikasjon

Slack, Discord, GitHub-issues, pull request-kommentarer og foruminnlegg støtter alle Markdown-formatering. Under kodegjennomganger, feilrapportering eller teamsamtaler lar Markdown deg formatere meldingen din tydelig uten å avbryte samtaleflyten.

Vanlige spørsmål (FAQ)

Kan jeg bruke HTML inne i Markdown?

Ja, Markdown tillater blanding av rå HTML. Hvis Markdown ikke støtter noe du trenger, kan du skrive HTML direkte og det passerer gjennom til utdataen. Ifølge CommonMark-spesifikasjonen gjenkjennes HTML-blokker og inline-HTML og passeres umodifiserte. Bruk dette sparsomt.

Hva er forskjellen mellom asterisker og understreker for utheving?

Funksjonelt identiske i CommonMark — *tekst* og _tekst_ produserer begge kursiv, **tekst** og __tekst__ produserer begge fet. Valget er stilistisk. Mange team foretrekker asterisker for konsistens og fordi de er enklere å skrive på de fleste tastaturer.

Hvordan fungerer linjeskift i Markdown?

Dette er en vanlig forvirring. Et enkelt linjeskift i kilden behandles som et mellomrom. For å opprette et ekte linjeskift (<br> i HTML), legg til to mellomrom på slutten av linjen før du trykker Enter, eller bruk en omvendt skråstrek før linjeskiftet. For avsnittsskift, bruk en tom linje.

Støttes tabeller overalt i Markdown?

Nei. Tabeller er en del av GitHub Flavored Markdown og andre utvidelser, men ikke CommonMark-standarden. De fleste moderne plattformer (GitHub, GitLab, Discord) støtter dem, men noen eldre Markdown-parsere gjenkjenner ikke pipe-syntaksen.

Hvordan escaper jeg spesialtegn?

Bruk en omvendt skråstrek (\) foran tegn med spesiell betydning i Markdown: omvendt skråstrek (\), backtick (`), asterisk (*), understrek (_), krøllparentes ({}), hakeparentes ([]), parentes (()), nummertegn (#), pluss (+), minus (-), punktum (.) og utropstegn (!). For eksempel renderer \*ikke kursiv\* asteriskene bokstavelig.

Hva er den beste måten å formatere kode i Markdown?

For inline-kode, bruk enkelt backtick: `kode her`. For kodeblokker, bruk tre backticks med en valgfri språktag (```javascript) for syntaksutheving. Unngå å rykke inn kode som en kodeblokk — inngjerdet blokker er tydeligere og mer portable.

Markdown-syntaksguide