Suggestions as you type
The Curvenote extension suggests what can go where the cursor is, and each suggestion comes with its documentation. Hover anything you have already written to see the same documentation again.
Directives¶
Type :::{ or ```{ and the extension lists every directive. Picking one on an empty line writes the whole directive, with the cursor in its body.
Figure 1:Directive names after :::{, each with a one-line summary.
Roles¶
Type { in a line of text for the roles, and picking one leaves the cursor between the backticks. Each cite: variant says what it writes, so {cite:p} and {cite:t} are easy to tell apart.
Figure 2:Each cite variant with what it writes in the page.
Options¶
Inside a {name …} header, options are written as key="" with the cursor between the quotes, for directives and roles. On a directive’s :key: lines, the directive’s own options come first, and the ones already written are left out.
Figure 3:The image directive’s options on a :key: line.
Frontmatter at the top of a page and your myst.yml get suggestions too, covered in Frontmatter and myst.yml. When a directive, role or option isn’t one MyST knows, the extension says so; see Checks and quick fixes.
- MyST
- Markedly Structured Text