Markdown förklarat på 5 minuter
Du har förmodligen använt Markdown utan att veta om det. Har du någon gång skrivit **fetstil** i ett Slack-meddelande? Skrivit en README på GitHub? Formaterat ett inlägg på Reddit? Det är Markdown.
Markdown är ett lättviktigt sätt att formatera vanlig text med enkla symboler. I stället för att klicka på verktygsfältsknappar för fetstil, kursiv, rubriker och listor skriver du ett par tecken som anger den formatering du vill ha. Det skapades 2004 av John Gruber och Aaron Swartz och har sedan dess blivit standardformateringsspråket för utvecklare, skribenter och alla som arbetar med text på webben.
Varför Markdown finns
Innan Markdown innebar textformatering för webben att skriva HTML. För att göra ett ord fetstilt skrev du <strong>fetstil</strong>. För att skapa en lista behövde du <ul><li>objekt</li></ul>. HTML är kraftfullt men ordrik och svårt att läsa i råformat.
Markdown löser detta genom att erbjuda en lättläst stenografi. Råtexten är enkel att läsa även innan den renderas. Det formaterade resultatet är rent och professionellt. Du får det bästa av båda världar: läsbar källtext och polerad utdata.
Visste du att? Markdowns designfilosofi är att råtexten ska vara "publiceringsklar som den är, som vanlig text, utan att se ut som om den märkts upp med taggar eller formateringsinstruktioner." Det är därför Markdown-syntaxen använder tecken som visuellt antyder den formatering de ger.
Den grundläggande syntaxen
Här är allt du behöver veta för att börja använda Markdown produktivt.
Rubriker
Använd brädgård-symboler (#) för att skapa rubriker. Fler symboler ger mindre rubriker.
# Rubrik 1 (störst)
## Rubrik 2
### Rubrik 3
#### Rubrik 4
Fetstil och kursiv
Omge text med asterisker eller understreck:
**fetstil text**
*kursiv text*
***fetstil och kursiv***
Listor
Oordnade listor använder bindestreck, asterisker eller plustecken. Ordnade listor använder siffror.
- Första punkten
- Andra punkten
- Tredje punkten
1. Första steget
2. Andra steget
3. Tredje steget
Länkar
Hakparenteser för texten, vanliga parenteser för URL:en:
[Klicka här](https://example.com)
Bilder
Som länkar, men med ett utropstecken framför:
Blockcitat
Använd ett större-än-tecken:
> Det här är ett citat. Det kommer att dras in och stilas annorlunda.
Kod
Backtick för inline-kod, tre backtick för kodblock:
Använd funktionen `print()` för att skriva ut text.
För flerraders kodblock, använd tre backtick med en valfri språkidentifierare:
```python
def hello():
print("Hej, världen!")
```
Horisontella linjer
Tre eller fler bindestreck, asterisker eller understreck:
---
Tabeller
Använd rör och bindestreck:
| Namn | Roll | Plats |
| --- | --- | --- |
| Alice | Utvecklare | Berlin |
| Bob | Designer | London |
Var Markdown används
Markdown finns överallt:
Mjukvaruutveckling
- GitHub, GitLab, Bitbucket: README-filer, issues, pull requests och dokumentation skrivs alla i Markdown.
- Stack Overflow: Frågor och svar använder Markdown-formatering.
- Koddokumentation: Många dokumentationsgeneratorer (Docusaurus, MkDocs, Jekyll) använder Markdown som källformat.
Kommunikation
- Slack: Stöder en delmängd av Markdown för meddelandeformatering.
- Discord: Använder Markdown för fetstil, kursiv, kodblock med mera.
- Reddit: Inlägg och kommentarer formateras med Markdown.
Skrivande och publicering
- Bloggar: Många statiska webbplatsgeneratorer använder Markdown-filer som innehållskällor.
- Böcker: Flera publiceringsverktyg accepterar Markdown-manuskript.
- Anteckningar: Appar som Obsidian, Notion, Bear och Typora är byggda kring Markdown.
Dokumentation
- Teknisk dokumentation: API-dokumentation, användarguider och wikis använder ofta Markdown.
- Interna kunskapsbaser: Många team använder Markdown-baserade wikis.
Tips Du kan förhandsgranska och öva Markdown just nu, gratis, i webbläsaren: Skriv i Markdown. Se din formaterade utdata i realtid medan du skriver.
Markdown-varianter
En sak att känna till: det finns olika "varianter" av Markdown. Kärnsyntaxen är densamma överallt, men vissa plattformar lägger till tillägg:
| Variant | Extra funktioner | Används av |
|---|---|---|
| CommonMark | Strikt specifikation | Allmän standard |
| GitHub Flavored Markdown (GFM) | Uppgiftslistor, tabeller, genomstruken text, auto-länkning | GitHub |
| MultiMarkdown | Fotnoter, citat, metadata | Akademiskt skrivande |
| R Markdown | Inbäddad R-kod, dataanalys | Datavetenskap |
Skillnaderna handlar mest om avancerade funktioner. Grunderna (rubriker, fetstil, kursiv, listor, länkar, bilder, kod) fungerar likadant överallt.
Vanliga misstag
Glömma tomma rader
Markdown kräver en tom rad före och efter många element. En rubrik behöver en tom rad före. En lista behöver en tom rad före och efter. Att glömma dessa tomma rader är den vanligaste källan till renderingsproblem.
Inkonsekventa listmarkörer
Att blanda -, * och + i samma lista kan orsaka oväntad rendering. Välj en och håll dig till den.
Mellanslag efter symboler
Vissa Markdown-processorer kräver ett mellanslag efter # i rubriker och efter - i listor. Inkludera alltid mellanslaget för att vara på den säkra sidan.
# Korrekt rubrik
#Inkorrekt rubrik
- Korrekt listobjekt
-Inkorrekt listobjekt
Observera Markdown stöder inte alla formateringsbehov. Om du behöver komplexa layouter, färgad text, exakt typografi eller utskriftsfärdiga dokument kan du behöva HTML, LaTeX eller ett ordbehandlingsprogram. Markdown passar bäst för strukturerat, textfokuserat innehåll.
Varför Markdown är värt att lära sig
Markdown tar fem minuter att lära sig och sparar timmar på sikt. När du väl kan det kan du:
- Skriva dokumentation som renderas vackert på GitHub
- Formatera meddelanden i Slack och Discord utan att röra musen
- Ta strukturerade anteckningar som är portabla mellan appar
- Skapa blogginlägg och webbinnehåll från vanliga textfiler
- Samarbeta om textbaserade dokument utan kompatibilitetsproblem med format
Förhållandet investering till utdelning är ett av de bästa i hela teknikvärlden.
Börja skriva i Markdown nu:
Gratis, i webbläsaren, med realtidsförhandsgranskning medan du skriver.