README

callouty-theorem extension for Quarto

This Quarto extension wraps your theorems and proofs in callout blocks for better visual appeal.

Installation

quarto add sun123zxy/quarto-callouty-theorem

This will install the extension under the _extensions subdirectory. If you’re using version control, you may want to check in this directory.

Modify the YAML front matter of your document or _quarto.yml to include the extension. In most scenarios, you may only wish to enable this extension for HTML output like so:

format:
  html:
    filters:
      - callouty-theorem

Though you can also enable it globally for all formats:

filters:
  - callouty-theorem

Usage & Examples

Here is a typical configuration:

callouty-theorem:
  proof: # Type of the theorem or proof. Note that for theorems 3-letter abbreviation (`thm`, etc.) should be used
    override-title: true # Whether to override the title of the callout block by the name of the theorem or proof
    callout: # Configuration for the callout block. Refer to Quarto's Callout documentation for more information
      type: note
      appearance: default
      collapse: true
      icon: true

Above will wrap all proofs into collapsable callout blocks with its icon and an overrided title.

You can override callout settings for individual theorem/proof divs by adding attributes directly on the div. Per-div attributes take precedence over the global callouty-theorem metadata config.

See the source code of example.qmd for details.

License

This extension is licensed under the MIT License.