Markdown-fusklapp

Steg 1 / 3 33%

Välj ett Markdown-ämne

Börja med en grupp exempel och öppna sedan hela referensen.

Viktig Markdown-syntax, grupperad efter kategori och visad som kopierbar källtext tillsammans med resultatet från en riktig parser. Referensen omfattar grunderna i CommonMark (rubriker, listor, betoning, länkar, bilder och inhägnade kodblock) samt tillägg i GitHub Flavored Markdown (tabeller, uppgiftslistor, genomstrykning och automatisk länkning av vanliga URL:er). Ha den nära till hands när du arbetar i GitHub, GitLab, Obsidian och generatorer för statiska webbplatser.

Så använder du fusklappen

  1. 1

    Bläddra efter kategori

    Gå till rubriker, listor, kod, länkar, tabeller eller GFM-tillägg.

  2. 2

    Jämför källa och resultat

    Varje exempel visar rå Markdown bredvid resultatet från en riktig GFM-parser.

  3. 3

    Kopiera kodavsnittet

    Tryck på kopiera för att hämta källan till valfritt exempel.

  4. 4

    Kontrollera syntaxetiketten

    Varje exempel är märkt som CommonMark eller GitHub Flavored Markdown (GFM).

Rubriker

# H1-rubrik
## H2-avsnitt
### H3-underavsnitt

Använd ATX-stilen (#) i stället för Setext (=== under texten). Alla parsrar stöder båda, men ATX är lättare att läsa i en diff.

Betoning

*kursiv* eller _kursiv_, **fet** eller __fet__, ***fet kursiv***. GFM lägger till ~~genomstrykning~~.

Listor

Oordnade listor använder -, * eller + (välj en och håll dig till den):

- Första
- Andra
  - Nästlad (två blanksteg)

Ordnade listor numreras om automatiskt:

1. Objekt
1. Objekt
1. Objekt

Kod

Inline: `code`. Inhägnade block med valfri språktagg:

```python
def hello(name):
    return f"Hej, {name}"
```

Dra in med fyra blanksteg för ett kodblock om du föredrar den äldre syntaxen.

Länkar och bilder

[Länktext](https://example.com)
[Länk med titel](https://example.com "Verktygstips")
![Alternativtext](/path/to/image.png)

Referensstilen håller långa URL:er utanför stycket:

Se [dokumentationen][1].

[1]: https://example.com/docs

Tabeller (GFM)

| Col A | Col B |
|-------|------:|
| a     |     1 |
| b     |    22 |

Justering anges med kolon i avgränsarraden: :--- vänster, :---: centrerat, ---: höger.

Uppgiftslistor (GFM)

- [x] Klart
- [ ] Att göra

Vanliga fallgropar

  • Två blanksteg i slutet infogar en radbrytning inuti ett stycke. Ett enda blanksteg fogar bara ihop raderna.
  • En tom rad krävs före de flesta blockelement (rubriker, listor, kodblock).
  • Dra inte in listmarkörer med tabbar om din renderare förväntar sig blanksteg; dra in med två eller fyra blanksteg.
  • Escapa med omvänt snedstreck för bokstavlig skiljetecken: \*inte kursiv\*.
  • Smarta citattecken skiljer sig åt beroende på renderare. GitHub lämnar dem orörda; Pandoc konverterar dem.

Vanliga frågor

CommonMark definierar den portabla kärnan, bland annat rubriker, listor, länkar och inhägnade kodblock med valfri informationssträng. GFM lägger till tabeller, uppgiftslistor, genomstrykning och automatisk länkning av vanliga URL:er. Andra redigerare kan stödja en delmängd eller lägga till egna tillägg.

Markdown behandlar en enda radbrytning som ett blanksteg. För en <br> avslutar du raden med två blanksteg, eller använder \ i slutet av raden i GFM.

Ja, i de flesta parsrar släpps HTML-taggar på blocknivå igenom. Vissa renderare sanerar dem (GitHub tar bort inline-skript och händelseattribut).

CommonMark har ingen inbyggd syntax för innehållsförteckningar. GitHub skapar rubrikankare och visar en översikt för filer med flera rubriker. Andra plattformar har egna regler: MkDocs kan använda [TOC] när TOC-tillägget är aktivt, medan Docusaurus bygger sidans innehållsförteckning från rubrikerna.

Reglerna i CommonMark och GFM gör det. Obsidian lägger dock till wikilänkar ([[Sidnamn]]), callouts och inbäddade block som bara finns i Obsidian – dessa ingår inte i den här fusklappen.

Relaterade verktyg