IncludeFrontMatter

ConvertOptions.IncludeFrontMatter property

Gets or sets a value indicating whether to prepend YAML front matter to the Markdown output. When enabled, document metadata (title, author, format, page count) is extracted and written as a YAML block at the beginning of the output.

public bool IncludeFrontMatter { get; set; }

Property Value

Default is false.

Remarks

Front matter is commonly used by static site generators such as Jekyll, Hugo, and Docusaurus. Only non-empty metadata fields are included.

Examples

var options = new ConvertOptions { IncludeFrontMatter = true };
string markdown = MarkdownConverter.ToMarkdown("report.docx", options);
// Output starts with:
// ---
// title: "Q3 Report"
// author: "Jane Doe"
// format: Docx
// pages: 12
// ---

See Also

ImageExportStrategy IncludeHiddenSheets