ConvertOptions class Leave feedback
On this page
Provides options for customizing the document conversion process to Markdown format.
This class allows you to configure how documents are converted to Markdown, including how images are exported, how resource URIs are written, which pages to convert, and how heading levels are adjusted.
By default, images are embedded as Base64 strings in the Markdown output.
The ConvertOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of the ConvertOptions class. |
| Property | Description |
|---|---|
| flavor | The target Markdown dialect. Default is MarkdownFlavor.git_hub. |
| heading_level_offset | The offset to apply to all heading levels in the Markdown output. Default is 0 (no change). |
| image_export_strategy | The strategy for handling images during conversion. Default is ExportImagesAsBase64Strategy. |
| include_front_matter | The option indicating whether to prepend YAML front matter to the Markdown output. Default is False. |
| include_hidden_sheets | The property indicates whether hidden worksheets are included in spreadsheet conversions. |
| max_columns | The maximum number of columns to include per table when converting spreadsheets; columns beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default). |
| max_rows | The maximum number of data rows to include per worksheet when converting spreadsheets; rows beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default). |
| page_numbers | The page numbers to convert, as a list of 1‑based page or worksheet numbers. |
| sheet_separator | The separator inserted between worksheets in spreadsheet conversions. |
| uri_export_strategy | The strategy for customizing resource URIs written to Markdown output. |
- module
groupdocs.markdown
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.
