summary directive

summary directive#

The summary directive creates a chapter/section summary admonition, styled to highlight key takeaways.

Basic usage#

:::{summary} Key points
- Derivative = rate of change
- Integral = accumulation
:::

Key points

  • Derivative = rate of change

  • Integral = accumulation

Syntax overview#

:::{summary} Title text
- Key point 1
- Key point 2
:::

The first argument is the title (required). The body typically contains a bulleted list of key points.

Options#

No options.

Source#

src/munchboka_edutools/directives/admonitions.py