Markdown
Frontmatter
This group works with the frontmatter of a Markdown file: the metadata block written between
two --- lines at the very top, which tools like static site generators read for the title, the
date or the tags. It is the Markdown counterpart of Set Document Properties (.docx) and Set
Document Metadata (PDF).
Prerequisite: the workflow must already have a Markdown document created or opened.
- Document: indicates which document in the workflow the instruction applies to. If left empty, the current document is used. If the document doesn’t exist, the instruction simply does nothing.
- Field name: the name to the left of the colon. It is required: with it empty nothing happens.
- Dynamic values (
@name): in any text field you can type@followed by the name of a value saved earlier in the workflow.
Read Frontmatter Field .md
Reads a field of the frontmatter into a saved value.
When to use it: to decide what the workflow does next based on the metadata — for example, to skip a document marked as a draft.
| Parameter | Meaning | Default | Required |
|---|---|---|---|
| Document | Document the instruction applies to | (current document) | No |
| Field name | Name of the field. Supports @name |
(empty) | Yes |
| Save value key | Name to save the value under | (empty) | No |
| Save found key | Name to save yes/no (is the field there) under | (empty) | No |
Important behavior: this instruction only reads — it changes nothing. If the document has no frontmatter, or the field is not in it, the value is saved empty and “found” is saved as No.
Remove Frontmatter Field .md
Takes a field out of the frontmatter.
When to use it: to drop a working field —a draft marker, an internal note— before publishing.
| Parameter | Meaning | Default | Required |
|---|---|---|---|
| Document | Document the instruction applies to | (current document) | No |
| Field name | Name of the field. Supports @name |
(empty) | Yes |
Important behavior: removing the last field removes the whole block, so the document is not
left with an empty --- pair. A field that is not there, or a document with no frontmatter, does
nothing.
Set Frontmatter Field .md
Writes a field of the frontmatter, creating the block if the document has none.
When to use it: to stamp the title, the date or the author of the document from values the workflow gathered.
| Parameter | Meaning | Default | Required |
|---|---|---|---|
| Document | Document the instruction applies to | (current document) | No |
| Field name | Name of the field. Supports @name |
(empty) | Yes |
| Value | Value of the field. Supports @name |
(empty) | No |
Important behavior: if the document has no frontmatter, the block is created at the top and the rest of the document is kept below it. A field that is already there is replaced, not duplicated. An empty value writes an empty field — to take a field out, use Remove Frontmatter Field. Line breaks in the value become spaces, because a field is one line.
This documentation is the help of the application, and it comes underCreative Commons Attribution 4.0.