Skriva sidor
Riktlinjer för att skriva dokumentationssidor i Markdown.
Grundstruktur
Varje sida är en Markdown-fil med YAML-frontmatter högst upp. Titeln sätts i
frontmatter och blir sidans h1.
Rubriker
Använd h2 och h3 för att strukturera innehållet — dessa dyker automatiskt
upp i högerspaltens innehållsförteckning.
---
title: Min sida
---
## Första avsnittet
Innehåll här.
Kodblock
Kodblock med språkangivelse får syntax enligt Markdown-standard och en kopieringsknapp vid hovring.
function hello(): string
{
return 'Hej världen';
}
Tabeller
| Kolumn A | Kolumn B | Kolumn C |
|---|---|---|
| Ett | Två | Tre |
| Fyra | Fem | Sex |
Callouts
Använd GitHub-stilens varningsblock för att lyfta fram viktig information.
Note
Detta är en informativ notering som inte kräver åtgärd.
Warning
Detta är en varning — läsaren bör vara uppmärksam innan de går vidare.
Se även navigation för hur sidor grupperas i menyn.