Library
REF 07 Cheat Sheet · Reference

Markdown extensions

Instruqt extends standard Markdown in assignment.md with interactive elements, variable interpolation, and embedded media. CommonMark-compatible underneath.

Tab buttons Inline navigation

Click-to-jump references to a tab. Optional variant, color, block, href.

[button label="Terminal 1"](tab-0) [button label="Run check" variant="success"](#) [button label="Stop" variant="danger"](#) [button label="Next" variant="outline"](section--02-deploy)
Variable interpolation Dynamic values

Inject runtime values from agent variable set or auto-injected env vars.

Works inside any string field — cmd:, url:, path:, body Markdown, fenced code blocks, button labels, table cells, image alt-text. Resolved before fence parsing — no escaping needed inside backticks.

[[ Instruqt-Var key="DB_URL" hostname="workstation" ]]
Admonitions GitHub-style callouts

Quoted blocks with type tag. Render as colored callouts.

> [!NOTE] > Tip the learner should know. > [!WARNING] > What can go wrong. > [!IMPORTANT] > [!TIP]
Headings Two styles supported

ATX (## Title) and Setext (underlined) both render identically.

```

ATX-style heading

Setext H1 =========

Setext H2 --------- ```

Disambiguation: Text\n--- with no blank line is a Setext H2. \n---\n with blank lines around is a horizontal rule. Both are common; the difference matters when adding step dividers.
Inline HTML Allowed in body and notes

Markdown body and notes: slide content accept raw HTML.

Use <details> for opt-in hints. Inline <span> / styling for credential display, brand colors, conditional emphasis.

<details><summary> How to do X </summary> <p>Hint goes here.</p> </details> <span style="color:#04342c;"> Brand-colored text </span>
Embedded media Body and notes

Images via standard Markdown; video via raw HTML; iframes for external interactive content.

Asset paths use forward slashes (../assets/file). Backslash paths render but are a Windows authoring artifact — normalize before push.

![Splash](../assets/splash.png) <video src="../assets/demo.mp4" controls width="600"></video> <iframe src="https://..." width="100%" height="400"> </iframe>
notes: pre-challenge slides Three types · multi-slide arrays

Frontmatter notes: is a list. Render as full-screen overlays before the challenge starts (requires track-level enhanced_loading: false).

type: text Markdown contents. Supports inline <style> blocks for per-slide CSS.
type: video YouTube embed URL or local ../assets/*.mp4. YouTube supports ?start=N&end=M clipping.
type: image Image URL. Use a single full-width image as a splash slide.
Common idiom: first notes: slide is a single splash image — - type: text\n contents: '![Splash](../assets/splash.png)' — followed by a second text slide for welcome copy.
Notes