mdast2docx logo Md2Docx
Version 0.1.0API DocsInterfaces

InfoBoxOptions

Updated 9 hr ago

Defined in: frontmatter.ts:47

Properties

enabled?

optional enabled?: boolean

Defined in: frontmatter.ts:49

Whether the info box is enabled

fields?

optional fields?: string[]

Defined in: frontmatter.ts:57

Specific frontmatter fields to display, and their order. Default: ["author", "date", "version", "status", "tags"]

format?

optional format?: "blockquote" | "table"

Defined in: frontmatter.ts:51

Format of the info box: "blockquote" (callout box) or "table". Default: "blockquote"

optional header?: string

Defined in: frontmatter.ts:55

Header title inside the info box, e.g. "Document Overview"

labels?

optional labels?: Record<string, string>

Defined in: frontmatter.ts:59

Custom label mapping, e.g. \{ author: "Author", lastModifiedBy: "Last Updated" \}

position?

optional position?: "after-title" | "top"

Defined in: frontmatter.ts:53

Placement: "after-title" (after first H1) or "top" (at the very beginning). Default: "after-title"

On this page