Markdown

Images

The img section embeds an uploaded asset — a logo, a diagram, a photo — in your documents and e-mails.

AI assisted, human approved — novem uses AI to review and keep our documentation up to date.

Available in: documents and e-mails.

{{ img                          # section type (image also works)
  ref: logo.png                 # asset to embed
  alt: The novem logo           # accessibility text
  width: 200                    # bare numbers are pixels
  align: center                 # left | right | center
  caption: Fig 1 — the logo     # optional figcaption
  link: https://novem.io        # optional click-through
}}

Where the vis section embeds a live novem visualisation, the img section embeds a static asset: a file you've uploaded to a plot, document or mail under its assets/ path (/v1/users/:user/vis/{p,d,m}/:vde/assets/).

It is a single statement section — self-closing, no content — with the keyword img (image is accepted as an alias, for symmetry with vis/visualisation).

In e-mails the asset is not hot-linked: at send time the image bytes are attached to the message itself and referenced inline, so the e-mail renders at full fidelity offline, in clients that block remote images, and across forwards. In terminal (ANSI) renders the image degrades to its alt text: [image: …].

keyword: ref
options: local asset name | FQNP

The only required option. Two shapes are accepted:

{{ img ref: logo.png }}                               # asset on this document/mail
{{ img ref: /u/alice/p/myplot/a/diagram.svg }}        # another VDE's asset (FQNP)
{{ image ref: /u/alice/p/myplot/assets/diagram.svg }} # FQNP long form

A bare name refers to an asset uploaded to the hosting document or mail itself; the FQNP forms pull an asset from any visualisation you can read.

keyword: alt
options: "accessibility text"
default: the asset's file name

Alternative text for screen readers and clients that don't render images. Also the text shown in terminal renders.

keyword: width / height
options: CSS length — 200, 200px, 80%, 12em, auto

Sizes the image. Bare numbers are treated as pixels. Pixel values also render correctly in desktop Outlook, which ignores CSS sizing on images; percentages and other units apply everywhere else.

keyword: align
options: left | right | center

Positions the image within its layout when it's narrower than full width.

keyword: caption
options: "caption text"

An optional caption rendered below the image. Plain text only — markdown is not processed here.

keyword: link
options: URL

Wraps the image in a link. Accepts http(s), mailto and relative or anchor targets; other schemes are rejected.

{{ img
  ref: logo.png
  alt: Acme Research
  width: 180
  align: center
}}

{{ img
  ref: /u/novem_demo/p/state_pop/a/methodology.png
  alt: Methodology flowchart
  width: 80%
  caption: Figure 2 — how the population estimates are derived
}}

{{ img ref: banner.png, alt: Read the full report, link: https://novem.io/u/acme/d/q3_report }}

Visualisation

Preview