Authoring field guide
Explore the rendered examples first, then open Show Markdown source to copy the exact input. Examples use four spaces for nested blocks, as required by Python Markdown.
Choose a pattern
Start with the content you need to explain.
-
Headings, lists, formatting, footnotes, tables, tooltips, and buttons.
-
Notes, collapsible details, alternative paths, and cards.
-
Highlighting, annotations, snippets, and the limits of directives.
-
Diagrams, equations, images, icons, and emoji.
Show Markdown source
<div class="grid cards" markdown>
- **[Prose and structure](prose.md)**
Headings, lists, formatting, footnotes, tables, tooltips, and buttons.
- **[Callouts and tabs](callouts.md)**
Notes, collapsible details, alternative paths, and cards.
- **[Code and reuse](code.md)**
Highlighting, annotations, snippets, and the limits of directives.
- **[Visual explanations](visuals.md)**
Diagrams, equations, images, icons, and emoji.
</div>
Focused examples
- Front matter, formatting, lists, tables, footnotes, tooltips, and buttons
- Admonitions, tabs, and grids
- Code highlighting, annotations, snippets, and directives
- Diagrams, diagram models, math, images, and icons, and progress indicators
Page metadata
This page supplies a title and description in YAML front matter. The title appears in the page metadata and navigation context; the description is available to the site as page metadata.