YAML front matter Leave feedback
On this page
Enable include_front_matter 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.
from groupdocs.markdown import MarkdownConverter, ConvertOptions
def front_matter_example():
"""Convert a document to Markdown with YAML front matter extracted from metadata."""
# Step 1: Enable front matter generation in conversion options
options = ConvertOptions()
options.include_front_matter = True
# Step 2: Convert the document with front matter enabled
md = MarkdownConverter.to_markdown("business-plan.docx", convert_options=options)
# Step 3: Print the result -- YAML front matter appears at the top
print(md)
# Output:
# ---
# title: "Q3 Report"
# author: "Jane Doe"
# format: Docx
# pages: 12
# ---
#
# # Q3 Report
# ...
if __name__ == "__main__":
front_matter_example()
business-plan.docx is sample file used in this example. Click here to download it.
---
format: Docx
pages: 18
---
| HOME BASED | | |
| --- | --- | --- |
| | | |
| PROFESSIONAL SERVICES | | |
...
---
format: Docx
pages: 18
---
| :
"""Convert a document with both YAML front matter and heading level offset."""
# Step 1: Configure options with front matter and heading offset
options = ConvertOptions()
options.include_front_matter = True # add YAML metadata block
options.heading_level_offset = 1 # shift headings down one level
# Step 2: Convert and save to a file using keyword argument for options
MarkdownConverter.to_file("annual-report.docx", "front-matter-combined.md", convert_options=options)
if __name__ == "__main__":
front_matter_combined()
annual-report.docx is sample file used in this example. Click here to download it.
---
author: "Brianna Thielen"
format: Docx
pages: 1
---
[queryEmployees]
Employee Information for Employee [EmployeeID]: [FirstName] [LastName]
...
---
author: "Brianna Thielen"
format: Docx
pages: 1
---
[queryEmployees]
Employee Information for Employee [EmployeeID]: [FirstName] [LastName]
[TRUNCATED]
Only non-empty fields are included:
| Field | Source | Example |
|---|---|---|
title | BuiltInDocumentProperties.Title | "Q3 Report" |
author | BuiltInDocumentProperties.Author | "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.
