For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quarto

Learn how Vale handles Quarto content.

Requires Vale v3.18.0 or later. Earlier versions can approximate support by assigning the format: qmd = md under [formats].

Quarto is Pandoc Markdown plus knitr- and Jupyter-style code cells. The cells are Markdown already—a cell fence is a fenced code block and an inline expression is a code span—so Vale parses the Pandoc layer on top: fenced divs, attributes, and shortcodes.

The supported extension is .qmd.

By default, Vale ignores:

  • Code cells: ```{r} fences, including their #| options.

  • Inline expressions: `r mean(x)` and `{python} 1 + 1.

  • Fenced-div lines: ::: {.callout-note} and its closing :::—the content between them is linted.

  • Shortcodes: {{< video ... >}}, inline or standing alone.

  • Attributes: a heading's {#sec-overview}, and the {.underline} of [text]{.underline}—the text itself is still linted.

  • Fenced blocks, code spans, and URLs, as in Markdown.

Divs

A fenced div's classes become class scopes for everything inside it, so a rule can target a callout, a margin note, or a column by name:

extends: existence
message: "Don't use '%s' in a callout."
scope: class.callout-note
level: error
tokens:
  - obviously

Divs nest—by fence length (:::: around :::) or same-length fences alike—and a block deep inside carries every enclosing class.

Math and citations

Math is ignored, both $$…$$ display blocks and $x^2$ inline spans. See Math for the delimiter rules, which are what keep It costs $5 and $10 prose.

Citations ([@ref]) and cross-references (@sec-overview) are read as prose, since a bare bracket or @ is ordinary punctuation more often than not. To exclude them, use TokenIgnores:

Last updated