Så använder du Admonitions i Docusaurus
Admonitions är visuella boxar som används för att framhäva viktig information i din dokumentation. De kan till exempel användas för att visa tips, varningar eller anteckningar. I Docusaurus är Admonitions inbyggda och väldigt enkla att använda.
Admonitions gör det inte bara enklare att strukturera innehållet, de förbättrar också läsupplevelsen genom att visuellt guida läsaren till viktiga detaljer.
Exempel på Admonitions
Här är några exempel på hur du kan använda Admonitions i dina .mdx-filer.
Anteckningar
:::note
Det här är en anteckning. Perfekt för små noteringar eller förtydliganden.
:::
Visuellt resultat
Det här är en anteckning. Perfekt för små noteringar eller förtydliganden.
Tips
:::tip
Det här är ett tips! Använd det för att lyfta fram smarta lösningar.
:::
Visuellt resultat
Det här är ett tips! Använd det för att lyfta fram smarta lösningar.
Varningar
:::caution
Det här är en varning. Perfekt för att flagga potentiella problem.
:::
Visuellt resultat
Det här är en varning. Perfekt för att flagga potentiella problem.
Fara
:::danger
Det här är en farlig åtgärd! Se till att användaren vet vad de gör.
:::
Det här är en farlig åtgärd! Se till att användaren vet vad de gör.
Anpassa Admonitions
Vill du ändra hur Admonitions ser ut på din sajt? Docusaurus gör det enkelt att anpassa stilarna. Öppna din CSS-fil (vanligtvis src/css/custom.css) och lägg till regler för de olika klasserna.
Varför använda Admonitions?
- Förbättrad läsbarhet – Admonitions hjälper läsaren att snabbt identifiera viktig information.
- Visuell variation – Bryter upp textmassor och gör dokumentationen mer engagerande.
- Användarvänlighet – Superenkla att implementera med Markdown.