YAML front matter Leave feedback
On this page
Call setIncludeFrontMatter(true) to extract document metadata into a YAML block at the beginning of the Markdown output. This is commonly used by static site generators like Jekyll, Hugo, and Docusaurus.
import com.groupdocs.markdown.*;
public class FrontMatterExample {
public static void main(String[] args) {
DocumentConvertOptions options = new DocumentConvertOptions();
options.setIncludeFrontMatter(true);
MarkdownConverter.toFile("business-plan.docx", "front-matter-example.md", options);
// Output:
// ---
// title: "Q3 Report"
// author: "Jane Doe"
// format: Docx
// pages: 12
// ---
//
// # Q3 Report
// ...
}
}
business-plan.docx is a sample file used in this example. Click here to download it.
---
title: "Meridian Outdoor Co. — Business Plan"
author: "Meridian Outdoor Co."
format: DOCX
pages: 5
---
**Meridian Outdoor Co. — Business Plan**
[TRUNCATED]
import com.groupdocs.markdown.*;
public class FrontMatterCombined {
public static void main(String[] args) {
DocumentConvertOptions options = new DocumentConvertOptions();
options.setIncludeFrontMatter(true);
options.setHeadingLevelOffset(1);
MarkdownConverter.toFile("annual-report.docx", "front-matter-combined.md", options);
}
}
annual-report.docx is a sample file used in this example. Click here to download it.
---
title: "Meridian Outdoor Co. — Annual Report 2025"
author: "Elena Márquez, CFO"
format: DOCX
pages: 6
---
**Annual Report 2025**
[TRUNCATED]
Only non-empty fields are included:
| Field | Source | Example |
|---|---|---|
title | Built-in document title property | "Q3 Report" |
author | Built-in document author property | "Jane Doe" |
format | Detected file format | Docx |
pages | Page or worksheet count | 12 |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
