Guide till Markdown-syntax
En tydlig fusklapp för vardagens Markdown. Varje block visar syntaxen och resultatet du får.
Vad är Markdown?
Markdown är ett lätt sätt att lägga till formatering i vanlig text. I stället för knappar och menyer använder du några enkla tecken, som # för en rubrik eller * för betoning, som förblir läsbara även som råtext.
Markdown skapades av John Gruber och Aaron Swartz 2004 och har blivit standarden för README-filer, dokumentation, anteckningar och webbplatser som GitHub och Reddit. Eftersom det bara är text förblir ditt skrivande portabelt och läsbart överallt.
Den här guiden går igenom den syntax du använder mest. Öppna valfritt exempel i Markdown Peek och tryck på mellanslag för att växla mellan källtexten och det renderade resultatet.
Rubriker
Börja en rad med ett till sex #-tecken. Fler #-tecken ger en mindre, djupare rubrik.
Markdown
# Heading 1 ## Heading 2 ### Heading 3 #### Heading 4
Resultat
Heading 1
Heading 2
Heading 3
Heading 4
Fet stil, kursiv och mer
Omge text med tecken för att betona den. Kombinera dem fritt.
Markdown
**Bold text** *Italic text* ***Bold and italic*** ~~Strikethrough~~ `Inline code`
Resultat
Bold text
Italic text
Bold and italic
Strikethrough
Inline code
Listor
Använd bindestreck, asterisk eller plustecken för punkter, och siffror för numrerade listor. Dra in för att skapa nivåer.
Markdown
- First item - Second item - Nested item - Third item 1. Step one 2. Step two
Resultat
- First item
- Second item
- Nested item
- Third item
- Step one
- Step two
Länkar
Skriv den synliga texten inom hakparenteser och adressen inom parenteser. En vanlig webb- eller e-postadress blir en länk av sig själv.
Markdown
[Markdown Peek](https://markdownpeek.com) https://markdownpeek.com
Bilder
En bild är en länk med ett inledande utropstecken. Texten inom hakparenteser är alternativtexten.
Markdown
Resultat
Citat
Börja en rad med > för att citera den. Lägg till ännu ett > för att nästla ett citat i ett citat.
Markdown
> A quote worth remembering. > > > And a nested one.
Resultat
A quote worth remembering.
And a nested one.
Kod
Omge kod i löpande text med enkla backticks och hela block med tre backticks. Lägg till ett språknamn så färgar Markdown Peek koden, som GitHub.
Markdown
Use `backticks` for inline code.
```js
function hi() {
console.log("Hello");
}
```Resultat
Use backticks for inline code.
function hi() {
console.log("Hello");
}Tabeller
Avgränsa kolumner med lodräta streck och understryk rubrikraden med bindestreck. Kolon styr justeringen.
Markdown
| Feature | Supported | |---------|:---------:| | Tables | Yes | | Code | Yes |
Resultat
| Feature | Supported |
|---|---|
| Tables | Yes |
| Code | Yes |
Horisontella linjer
Tre eller fler bindestreck, asterisker eller understreck på en egen rad ritar en avgränsare.
Markdown
Above the line. --- Below the line.
Resultat
Above the line.
Below the line.
Uppgiftslistor
Ett listobjekt med [ ] är en öppen uppgift, och [x] är en slutförd.
Markdown
- [x] Read the guide - [ ] Set as default app
Resultat
Info- och varningsrutor
Börja ett citat med [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] eller [!CAUTION] för att göra det till en färgad ruta, som på GitHub.
Markdown
> [!NOTE] > Useful to know, even when skimming. > [!WARNING] > Needs attention right away.
Resultat
Note
Useful to know, even when skimming.
Warning
Needs attention right away.
Fotnoter
Lägg till [^1] där en not hör hemma och skriv noten var som helst nedanför. Markdown Peek numrerar noterna, listar dem i slutet och länkar tillbaka till där du var.
Front matter
Nyckel- och värdepar mellan två --- rader allra överst i en fil, som i blogginlägg och agentfiler, visas som en snygg tabell.
Markdown
--- title: Lofoten author: Sam tags: travel --- # Five nights in March
Resultat
| title | author | tags |
|---|---|---|
| Lofoten | Sam | travel |
Five nights in March
Escape-tecken
Sätt ett omvänt snedstreck före ett tecken för att visa det som det är i stället för som formatering.
Markdown
\*Not italic\* \# Not a heading
Resultat
*Not italic*
# Not a heading
Matematik med LaTeX
Omge LaTeX med enkla dollartecken för matematik mitt i en mening, eller dubbla dollartecken för en formel på egen rad. Markdown Peek renderar båda, offline.
Markdown
Inline math like $E = mc^2$ works in a sentence. $$ a^2 + b^2 = c^2 $$
Resultat
Inline math like E = mc2 works in a sentence.
a2 + b2 = c2
Diagram med Mermaid
Öppna ett kodblock med mermaid och beskriv ett flödesschema eller sekvensdiagram i vanlig text. Markdown Peek ritar det åt dig, i ljust eller mörkt läge.
Markdown
```mermaid flowchart LR A[Write] --> B[Preview] B --> C[Share] ```
Resultat
Läs Markdown vackert på din Mac
Markdown Peek renderar vilken .md-fil som helst i enkel GitHub-stil, med kod i färg, Quick Look i Finder och PDF-export. Gratis i Mac App Store.
