Primitive functions

Quarkdown exposes primitive functions that provide fine-grained control over standard Markdown elements. These functions offer parameters that are not accessible through the regular Markdown syntax.

Headings

The .heading function creates headings with explicit control over numbering, page breaks, table of contents indexing, and custom identifiers. See the Headings page for details.

Images

The .image ^{docs ↗} function creates an image with fine-grained control over its properties, compared to the standard Markdown image syntax (![alt](url "title")).

.image {photo.jpg} label:{A photo}

Size constraints

The width and height parameters accept any size value.

.image {photo.jpg} label:{A photo} width:{200px} height:{150px}

.image {banner.svg} label:{Banner} width:{100%}

Caption

When a title is provided, it is used both as the image tooltip and as the figure caption.

Example 1

.image {assets/icon.svg} label:{Icon} title:{The Quarkdown icon} width:{64px}

Figure wrapping

By default, the image is wrapped in a figure block, which centers it and enables captioning and numbering. To disable this behavior, set figure:{no}, which produces a raw inline image instead.

Hello .image {icon.svg} label:{Icon} figure:{no} width:{16px} height:{16px} world!

Cross-referencing

The ref parameter assigns an ID that can be used with cross-references.

.image {diagram.png} label:{Architecture diagram} title:{System overview} ref:{arch-diagram} width:{400px}

See .reference {arch-diagram} for more details.

Media storage opt-out

By default, local images are copied to the output’s media directory when media storage is enabled. To prevent this and reference the image at its original path instead, set mediastorage:{no}.

.image {../banner.svg} label:{Banner} mediastorage:{no}

This is useful for images that should reference a fixed relative path, such as assets shared across multiple builds or maintained outside the project directory.