Skip to the content

Directive reference

Every directive Rejarsume reads, how it is written, each attribute and which are required, and what happens when one is wrong.

View as Markdown

A directive is a line, or a span of text, that starts with a colon and names a part Markdown has no word for. There are three forms:

FormWritten asUsed for
Inline, inside a line:name[text]{attributes}:icon
Block, on its own line::name[text]{attributes}::contact, ::tags, ::label, ::image, ::pagebreak
Block with content:::name{attributes} to ::::::entry

The text in square brackets and the attributes in braces are each optional where a directive does not need them. An attribute is written name="value".

::contact

One contact detail. Only read in the header, between the name and the first section.

PartRequiredMeaning
[text]noWhat prints
iconnoAn icon name
weightnoThe icon's weight
hrefnoWhere the line links to

See Contacts.

:::entry

A job, a degree or a project. Closes with a line that is only :::. Its first paragraph is the summary, and a list is its bullets.

AttributeRequiredMeaning
titlenoThe role, degree or project
subtitlenoThe employer, school or organisation
locationnoWhere
startnoYYYY-MM, YYYY, or any text, printed as written
endnoThe same
currentnoPresent or "true" for ongoing, "false" for not

See Entries.

::tags

::tags[a, b, c]. A comma-separated list drawn as a row of short items. No attributes.

::label

::label[text]{icon="name"}. One line with an icon in front.

PartRequiredMeaning
[text]noWhat prints
iconyesAn icon name
weightnoThe icon's weight

Without icon it is not read as a label, and the editor flags it.

:icon

:icon{name="translate"}. An icon inside a line of text.

AttributeRequiredMeaning
nameyesAn icon name
weightnoThe icon's weight

Without name it is left as the plain text :icon.

::image

::image[description]{id="…" width="40"}. A picture from the Assets store.

PartRequiredMeaning
[description]noWhat the image shows, for those who cannot see it
idyesThe image's id, written for you by Assets
widthnoA percentage of the text column

Without id it is not read as an image, and the editor flags it. See Images and page breaks.

::pagebreak

::pagebreak. Starts whatever follows on a new page. No attributes and no text.

Icon weights

Wherever weight is accepted, it is one of thin, light, regular, bold, fill or duotone. Any other value is ignored.

A directive Rejarsume does not know

A block directive with any other name, such as ::banner, is kept exactly as written and flagged. An inline directive with an unknown name is left as its plain :name text.