Skip to main content

Directives

Directives begin with @ and belong before the slide heading/content, immediately after a slide separator.

---
@type: compare
@layout: two-column
@transition: fade
@timing: 3min
@ref: "https://docs.aws.amazon.com/wellarchitected/" "AWS Well-Architected"

## Compare the options

Reference​

DirectivePurpose
@typeExplicit slide type, including content, code, compare, Canvas, quiz, tabs, timeline, checklist
@layoutDefault, two-column, three-column, grid-2x2, split-left, or split-right layout
@transitionEntry transition such as none, fade, slide, convex, concave, or zoom
@backgroundSlide color, gradient, or image background
@timingSpeaking time such as 3min or 90s
@canvas-idUnique Canvas element identifier
@refQuoted source URL and label; repeat for several references
@classAdditional CSS classes
@animationSlide animation class

Global background settings can provide a default; a slide directive overrides that default. Prefer semantic classes and theme variables when authoring custom styles.

Detection and explicit types​

The parser can infer some types from headings, checkboxes, code, or Canvas content. Use an explicit type when the intent matters, especially checklist versus quiz, or tabs versus comparison. Layout blocks (:::left, :::right, :::col, :::cell) structure content within the selected layout.

The parser also contains specialized directives used by generated decks. Consult its source and the current skill references before documenting an additional option.

Parser and directive handling