Markdown för anteckningar

Markdown ger dokumentation ett litet, granskningsbart källformat. Det är enkelt att jämföra ändringar tillsammans med kod och redigera i Rider, VS Code, GitLab eller GitHub. Vissa funktioner, exempelvis särskilda callouts, Mermaid och inbäddade komponenter, beror på renderaren.

Användbara mönster

# Inventory-system

## Syfte

Validerar item-ID vid återanslutning.

## Exempel

```text
Request -> Validation -> Inventory update
```

[Relaterad guide](./relaterad-sida.md)

Undvik nästlade tredubbla backticks om du kopierar detta direkt. Använd längre yttre kodstaket eller dela upp exemplet i verkliga dokument.

När passar tabeller?

Tabeller fungerar för kompakta jämförelser av exempelvis inställningar och standardvärden. Långa handledningar blir ofta lättare att läsa med rubriker och korta stycken. Ange gärna programmeringsspråk för kodblock så att syntaxmarkering fungerar.

Länkar och versionshantering

Relativa länkar passar filer inom ett repository som ska fungera även i forks. Absoluta webbplatssökvägar passar ofta publicerad Starlight-navigation med redirects. Kontrollera länkar efter flytt och uppdatera båda språken på flerspråkiga webbplatser.

Omfång och läsbarhet

Använd tydliga rubriker, undvik jättelånga stycken och visa förväntade resultat efter kommandon. Använd en central källa för generell teori och korslänka i stället för att skapa konkurrerande kopior.

Läs tydliga förklaringar och GitHub Markdown.