Heading level offset Leave feedback
On this page
Use heading_level_offset to shift all heading levels in the output by a fixed number. This is useful when embedding converted content inside a larger document where top-level headings are already in use.
from groupdocs.markdown import MarkdownConverter, ConvertOptions
def heading_offset_example():
"""Shift all heading levels by a fixed offset when converting to Markdown."""
# Step 1: Set the heading level offset to 2
options = ConvertOptions()
options.heading_level_offset = 2 # shift all headings down two levels
# Step 2: Convert the document and save it to a Markdown file
MarkdownConverter.to_file("annual-report.docx", "heading-offset-example.md", convert_options=options)
# Source: # Title -> Output: ### Title
# Source: ## Section -> Output: #### Section
# Heading levels are clamped to the range 1-6.
if __name__ == "__main__":
heading_offset_example()
annual-report.docx is sample file used in this example. Click here to download it.
