Groupdocs API References – groupdocs.markdown

Python-Net: ConvertOptions class

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions class

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:

Constructors

Constructor	Description
init	Initializes a new instance of the `ConvertOptions` class.

Properties

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.

Python-Net: ConvertResult class

Mon, 01 Jan 0001 00:00:00 +0000

ConvertResult class

Contains the output of a successful document-to-Markdown conversion.

All Convert methods throw on failure, so a returned ConvertResult always represents a successful conversion. Use ConvertResult.content to read the Markdown string (when converting to string) and ConvertResult.warnings to check for non-fatal issues.

The ConvertResult type exposes the following members:

Methods

Method	Description
failure	Creates a failed result with error information.
success	Creates a successful result without content. Used when the output was written to a stream or file.
success	Creates a successful result containing the converted Markdown content.

Properties

Property	Description
content	The converted Markdown content as a string.
error_message	The error message if the conversion failed, or None if it succeeded.
exception	The exception that caused the conversion to fail, or None if the conversion succeeded.
is_success	The conversion succeeded flag indicating whether the conversion completed successfully.
warnings	The non-fatal warnings that occurred during conversion.

Python-Net: CustomImageSavingArgs class

Mon, 01 Jan 0001 00:00:00 +0000

CustomImageSavingArgs class

Provides information and controls for saving a single image during document-to-Markdown conversion.

An instance of this class is passed to the callback registered with CustomImagesStrategy for each image found in the source document.

Use CustomImageSavingArgs.set_output_image_file_name to change the file name the image is saved under, or CustomImageSavingArgs.set_output_stream to redirect the image data to a custom stream. If neither method is called, the library uses the defaults provided by CustomImageSavingArgs.image_file_name and CustomImageSavingArgs.output_directory.

The CustomImageSavingArgs type exposes the following members:

Methods

Method	Description
set_output_image_file_name	Overrides the default file name for this image. The image will be saved under the specified name instead of the library-generated `CustomImageSavingArgs.image_file_name`.
set_output_stream	Redirects the image data to a custom writable stream instead of the default file output. The library will write the image bytes to this stream during conversion.
set_replacement_image	Provides a replacement image to use instead of the original image from the source document. The stream must contain the complete replacement image data (e.g., PNG or JPEG bytes). When set, the library writes this data to the output instead of the original image.

Properties

Property	Description
image_file_name	The default file name (without path) suggested by the library for this image.
image_file_name_output	The overridden file name set by `CustomImageSavingArgs.set_output_image_file_name`, or `None` if no override was specified.
output_directory	The output directory where images are being saved.
output_stream	The custom output stream set by `CustomImageSavingArgs.set_output_stream`, or `None` if no custom stream was specified.
replacement_image_stream	The replacement image stream set by `CustomImageSavingArgs.set_replacement_image`, or `None` if no replacement was specified.
shape_type	The type of the shape that contains the image in the source document (e.g., “Picture” or “Shape”).

Python-Net: CustomImagesStrategy class

Mon, 01 Jan 0001 00:00:00 +0000

CustomImagesStrategy class

Implements an image export strategy that gives you full control over how images are saved during conversion.

Supply an IImageSavingHandler implementation to rename images, redirect them to a custom stream, or apply any other custom logic when each image is encountered.

The CustomImagesStrategy type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the CustomImagesStrategy class.

Methods

Method	Description
get_image_stream	Gets a stream for writing the exported image to the file system.

Properties

Property	Description
images_folder	The physical folder where images will be saved on disk.
images_relative_path	The path used in the Markdown image references; when None or empty, the full `CustomImagesStrategy.images_folder` path is used, and it can be set to a relative path (e.g., “images”) for portable Markdown output.

Python-Net: CustomUriExportStrategy class

Mon, 01 Jan 0001 00:00:00 +0000

CustomUriExportStrategy class

Implements a URI export strategy that lets you customize how resource URIs are written to Markdown.

Supply a IUriSavingHandler implementation to rewrite resource URIs (for example, to prepend a CDN base URL).

The CustomUriExportStrategy type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `CustomUriExportStrategy` class.

Methods

Method	Description
update_resource_uri	Inherits documentation from the base `CustomUriExportStrategy.update_resource_uri` method.

Python-Net: DefaultUriExportStrategy class

Mon, 01 Jan 0001 00:00:00 +0000

DefaultUriExportStrategy class

Provides default URI handling that keeps the URIs generated by the library unchanged.

The DefaultUriExportStrategy type exposes the following members:

Constructors

Constructor	Description
init

Methods

Method	Description
update_resource_uri	Inherits documentation from the base implementation.

Python-Net: DocumentInfo class

Mon, 01 Jan 0001 00:00:00 +0000

DocumentInfo class

Provides read-only metadata about a loaded document, such as its format, page count, title, and encryption status.

Use MarkdownConverter.get_document_info or MarkdownConverter.get_info to obtain an instance of this class. The information is extracted from the source document without performing a full conversion, so it is a lightweight way to inspect a file before converting it.

The DocumentInfo type exposes the following members:

Properties

Property	Description
author	The document author extracted from its metadata, or an empty string if no author is available.
file_format	The detected file format of the document.
is_encrypted	The document is password-protected. Returns True if the document requires a password to open; otherwise, False.
page_count	The number of pages in the document, or the number of worksheets for spreadsheets, as a non‑negative integer.
title	The document title extracted from its metadata, or an empty string if no title is available.

Python-Net: DocumentProtectedException class

Mon, 01 Jan 0001 00:00:00 +0000

DocumentProtectedException class

The exception that is thrown when a document is password-protected and no password (or an incorrect password) was provided via LoadOptions.password.

The DocumentProtectedException type exposes the following members:

Python-Net: ExportImagesAsBase64Strategy class

Mon, 01 Jan 0001 00:00:00 +0000

ExportImagesAsBase64Strategy class

Implements an image export strategy that embeds images as Base64 strings directly in the Markdown.

This strategy converts all images to Base64 format and embeds them directly in the Markdown document using the data URI scheme. This eliminates the need for separate image files, making the Markdown document self-contained. However, this approach increases the size of the Markdown file and may not be supported by all Markdown viewers.

The ExportImagesAsBase64Strategy type exposes the following members:

Constructors

Constructor	Description
init

Methods

Method	Description
get_image_stream	Returns None to indicate that the image should be embedded as Base64.

Properties

Property	Description
images_folder	The images folder path is always an empty string because this strategy embeds images directly in the Markdown.

Python-Net: ExportImagesToFileSystemStrategy class

Mon, 01 Jan 0001 00:00:00 +0000

ExportImagesToFileSystemStrategy class

Saves images to a folder on disk during conversion.

By default, the Markdown output references images using the full ExportImagesToFileSystemStrategy.images_folder path. Set ExportImagesToFileSystemStrategy.images_relative_path to control the path that appears in the Markdown image links — typically a path relative to the output .md file.

The ExportImagesToFileSystemStrategy type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `ExportImagesToFileSystemStrategy` class.

Methods

Method	Description
get_image_stream	Returns a stream for writing the exported image to the file system.

Properties

Property	Description
images_folder	The physical folder where images will be saved on disk.
images_relative_path	The path used in the Markdown image references.

Python-Net: ExportOptions class

Mon, 01 Jan 0001 00:00:00 +0000

ExportOptions class

Options for exporting Markdown to a document format (reverse conversion).

Use this class with MarkdownConverter.from_markdown to control how the Markdown content is converted to a document format such as DOCX or PDF.

The ExportOptions type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the ExportOptions class.
init	Initializes a new instance of the `ExportOptions` class with the specified target format.

Properties

Property	Description
format	The target document format.

Python-Net: FileFormat class

Mon, 01 Jan 0001 00:00:00 +0000

FileFormat class

Specifies a document file format. Used both as input format (when loading a document for conversion to Markdown) and as output format (when exporting Markdown to a document).

Pass a value from this enum to the LoadOptions constructor to explicitly specify the source document format, or use FileFormat.unknown to let the library detect it automatically. Use MarkdownConverter.get_supported_formats to retrieve all formats supported for conversion.

The FileFormat type exposes the following members:

Fields

Field	Description
Unknown	The file format is not specified.
Doc	Microsoft Word 97-2003 Document (.doc).
Docx	Microsoft Word Document (.docx).
Docm	Microsoft Word Macro-Enabled Document (.docm).
Dot	Microsoft Word 97-2003 Template (.dot).
Dotx	Microsoft Word Template (.dotx).
Dotm	Microsoft Word Macro-Enabled Template (.dotm).
Rtf	Rich Text Format (.rtf).
Odt	OpenDocument Text (.odt).
Ott	OpenDocument Text Template (.ott).
Xlsx	Microsoft Excel Spreadsheet (.xlsx).
Xls	Microsoft Excel 97-2003 Spreadsheet (.xls).
Xlsb	Microsoft Excel Binary Spreadsheet (.xlsb).
Xlsm	Microsoft Excel Macro-Enabled Spreadsheet (.xlsm).
Csv	Comma-Separated Values (.csv).
Tsv	Tab-Separated Values (.tsv).
Ods	OpenDocument Spreadsheet (.ods).
Ots	OpenDocument Spreadsheet Template (.ots).
Pdf	Portable Document Format (.pdf).
Epub	Electronic Publication (.epub).
Mobi	Mobipocket E-Book (.mobi).
Txt	Plain Text (.txt).
Md	Markdown (.md). Used as input format for reverse conversion (Markdown to document).
Chm	Compiled HTML Help (.chm).

Python-Net: GroupDocsMarkdownException class

Mon, 01 Jan 0001 00:00:00 +0000

GroupDocsMarkdownException class

Represents a product-specific exception that is thrown during file processing.

The GroupDocsMarkdownException type exposes the following members:

Python-Net: IImageExportStrategy class

Mon, 01 Jan 0001 00:00:00 +0000

IImageExportStrategy class

Defines a strategy for handling image export during document-to-Markdown conversion.

The library ships with several built-in strategies:

ExportImagesAsBase64Strategy – embeds images inline as Base64 (the default).
ExportImagesToFileSystemStrategy – writes images to a folder on disk.
SkipImagesStrategy – omits images entirely.
CustomImagesStrategy – delegates to a callback you supply.

Implement this interface directly when none of the built-in strategies meet your needs.

The IImageExportStrategy type exposes the following members:

Methods

Method	Description
get_image_stream	Returns a writable stream for the image described by `context`.

Properties

Property	Description
images_folder	The folder path where exported images will be stored.

Python-Net: IImageSavingHandler class

Mon, 01 Jan 0001 00:00:00 +0000

IImageSavingHandler class

Callback interface invoked for each image encountered during conversion when using CustomImagesStrategy.

Implement this interface to rename images, redirect output to a custom stream, or apply other custom logic.

The IImageSavingHandler type exposes the following members:

Methods

Method	Description
handle	Called once for each image found in the source document during conversion.

Python-Net: IUriExportStrategy class

Mon, 01 Jan 0001 00:00:00 +0000

IUriExportStrategy class

Defines a strategy for customizing resource URIs that are written into the Markdown output during conversion.

Implement this interface to rewrite or transform the URIs that reference images or other external resources in the generated Markdown. For example, you can prepend a CDN base URL or change relative paths to absolute URLs.

The IUriExportStrategy type exposes the following members:

Methods

Method	Description
update_resource_uri	Called for each resource URI that will be written to the Markdown output, allowing modification of properties on `context` to customize the resulting URI.

Python-Net: IUriSavingHandler class

Mon, 01 Jan 0001 00:00:00 +0000

IUriSavingHandler class

Callback interface invoked for each resource URI during conversion when using CustomUriExportStrategy; implement it to rewrite resource URIs in the Markdown output.

The IUriSavingHandler type exposes the following members:

Methods

Method	Description
handle	Called once for each resource URI that will be written to the Markdown output.

Python-Net: ImageExportContext class

Mon, 01 Jan 0001 00:00:00 +0000

ImageExportContext class

Contains read-only information about a single image encountered during conversion, and is passed to IImageExportStrategy.get_image_stream(ImageExportContext).

The ImageExportContext type exposes the following members:

Properties

Property	Description
image_file_name	The image file name (without directory path).

Python-Net: InvalidFormatException class

Mon, 01 Jan 0001 00:00:00 +0000

InvalidFormatException class

The exception that is thrown when a file has an invalid format.

The InvalidFormatException type exposes the following members:

Python-Net: License class

Mon, 01 Jan 0001 00:00:00 +0000

License class

Manages GroupDocs.Markdown licensing.

Licensed builds unlock the full feature set of the wrapper at runtime. Unlicensed builds run in evaluation mode with the same API surface but with limits on output size and watermarked content.

The License type exposes the following members:

Methods

Method	Description
set_	Apply a license without instantiating `License`.
set_license	Apply a license to the current process.

Python-Net: LoadOptions class

Mon, 01 Jan 0001 00:00:00 +0000

LoadOptions class

Specifies additional options for loading a document, such as an explicit file format or a password for encrypted files.

By default, the library detects the file format automatically from the file extension or content. Use this class when you need to override automatic detection (for example, when loading from a stream without a file name) or when the document is password‑protected.

The LoadOptions type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `LoadOptions` class with automatic format detection.
init	Initializes a new instance of the `LoadOptions` class with an explicit file format.

Properties

Property	Description
file_format	The file format of the document to load.
password	The password used to open an encrypted document.

Python-Net: MarkdownConverter class

Mon, 01 Jan 0001 00:00:00 +0000

MarkdownConverter class

Converts documents from Word, Excel, PDF, and other formats to Markdown, offering static one-liner methods and an instance-based API with full control over conversion options.

Supported input formats include Word (DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT), Excel (XLS, XLSX, XLSB, XLSM, CSV, TSV, ODS, OTS), PDF, e‑books (EPUB, MOBI), plain text (TXT), and CHM help files. Call MarkdownConverter.get_supported_formats for the full list.

For quick, one‑shot conversions use the static methods MarkdownConverter.to_markdown, MarkdownConverter.to_file, and MarkdownConverter.get_info. When you need to customize the conversion (image handling, heading offsets, page selection) or retrieve document metadata alongside conversion, create an instance and call MarkdownConverter.convert or MarkdownConverter.get_document_info.

The instance implements System.IDisposable. Always dispose it when you are done, preferably with a using statement.

The MarkdownConverter type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new converter for the document at the specified file path.
init	Initializes a new converter that reads the document from the supplied stream. The file format is detected automatically from the stream content. If automatic detection is not possible, use the `MarkdownConverter.__init__(io.RawIOBase, LoadOptions)` overload and specify the format via `LoadOptions`.
init	Initializes a new converter for the document at the specified file path, using the given load options.
init	Initializes a new converter that reads the document from the supplied stream, using the given load options.

Methods

Method	Description
convert	Converts the loaded document to Markdown using default options and returns the result with the Markdown content in `ConvertResult.content`.
convert	Converts the loaded document to Markdown and writes the output to the specified stream.
convert	Converts the loaded document to Markdown and saves the result to a file at the specified output_file_path.
convert	Converts the loaded document to Markdown with the specified options and returns the result with the Markdown content in `ConvertResult.content`.
convert	Converts the loaded document to Markdown with the specified options, writing the output to a stream.
convert	Converts the loaded document to Markdown with the specified options and saves the result to a file.
convert_async	Asynchronously converts the loaded document to Markdown and returns the result as a string.
convert_async	Asynchronously converts the loaded document to Markdown with the specified options.
convert_async	Asynchronously converts the loaded document and saves the result to a file.
from_markdown	Converts a Markdown file to a document format, inferring the output format from the file extension of `output_path` (e.g., `.docx`, `.pdf`).
from_markdown	Converts a Markdown file to a document format with the specified export options.
from_markdown_string	Converts a Markdown string to a document and saves it to a file.
from_markdown_string	Converts a Markdown string to a document and writes it to a stream.
get_document_info	Retrieves metadata about the loaded document without performing a full conversion.
get_document_info_async	Asynchronously retrieves metadata about the loaded document.
get_info	Returns metadata about a document (format, page count, title, author, encryption status) without performing a full conversion.
get_info	Returns metadata about a document using the specified load options. Use this overload to supply a password when inspecting an encrypted document.
get_info_async	Asynchronously retrieves metadata about the document at the specified path.
get_supported_formats	Returns the complete list of FileFormat values that can be converted to Markdown.
to_file	Converts a document to Markdown and saves the result directly to a file.
to_file	Converts a document to Markdown with the specified conversion options and saves the result to a file.
to_file	Converts a document to Markdown with the specified load and conversion options, saving the result to a file.
to_file_async	Asynchronously converts the document and saves the result to a file.
to_markdown	Converts a document to Markdown in a single call and returns the Markdown string.
to_markdown	Converts a document to Markdown using the specified load options and returns the Markdown string.
to_markdown	Converts a document to Markdown using the specified conversion options and returns the Markdown string.
to_markdown	Converts a document to Markdown using the specified load and conversion options, and returns the Markdown string.
to_markdown_async	Asynchronously converts the document at the specified path to Markdown. File reading is performed asynchronously.
to_markdown_async	Asynchronously converts the document at the specified path to Markdown.

Python-Net: MarkdownFlavor class

Mon, 01 Jan 0001 00:00:00 +0000

MarkdownFlavor class

Specifies the target Markdown dialect for the conversion output.

The MarkdownFlavor type exposes the following members:

Fields

Field	Description
GitHub	GitHub Flavored Markdown—supports tables, strikethrough, and task lists.
CommonMark	Strict CommonMark output.

Python-Net: Metered class

Mon, 01 Jan 0001 00:00:00 +0000

Metered class

Manages metered (pay-per-use) licensing.

Metered licenses bill on actual consumption (typically pages or documents processed). Set the public/private key pair once at application startup; the wrapper reports usage back to the GroupDocs license server in the background.

The Metered type exposes the following members:

Methods

Method	Description
get_consumption_credit	Return the remaining metered credit for the current key.
get_consumption_quantity	Return the total metered quantity consumed so far.
set_metered_key	Activate metered billing with the given public/private key pair.

Python-Net: SkipImagesStrategy class

Mon, 01 Jan 0001 00:00:00 +0000

SkipImagesStrategy class

Implements an image export strategy that skips saving images during document conversion.

This strategy is useful when you want to convert a document to Markdown without saving the actual image files. When this strategy is used, the output Markdown will still contain image references (e.g., ), but the actual image files will not be saved to disk.

The SkipImagesStrategy type exposes the following members:

Constructors

Constructor	Description
init

Methods

Method	Description
get_image_stream	Returns None to indicate that the image should be skipped.

Properties

Property	Description
images_folder	The images folder is an empty string because this strategy does not use an images folder.

Python-Net: UriExportContext class

Mon, 01 Jan 0001 00:00:00 +0000

UriExportContext class

Contains information about a resource URI being written during conversion and is passed to IUriExportStrategy.update_resource_uri.

Read the default values from UriExportContext.resource_file_name and UriExportContext.resource_file_uri, then call UriExportContext.set_resource_file_name or UriExportContext.set_resource_file_uri to override them.

The UriExportContext type exposes the following members:

Methods

Method	Description
set_resource_file_name	Overrides the resource file name in the Markdown output.
set_resource_file_uri	Overrides the URI that will appear in the Markdown output.

Properties

Property	Description
resource_file_name	The default resource file name generated by the library.
resource_file_name_output	The overridden file name, or None if no override was set.
resource_file_uri	The default URI that the library would write into the Markdown output.
resource_file_uri_output	The overridden URI, or None if no override was set.

Python-Net: UriSavingArgs class

Mon, 01 Jan 0001 00:00:00 +0000

UriSavingArgs class

Provides information and controls for customizing how a resource URI is written during document-to-Markdown conversion.

Call UriSavingArgs.set_resource_file_uri to change the URI that appears in the Markdown output. If no override is set, the library uses the default UriSavingArgs.resource_file_uri.

The UriSavingArgs type exposes the following members:

Methods

Method	Description
set_resource_file_uri	Overrides the URI that will be written to the Markdown output for this resource.

Properties

Property	Description
resource_file_name	The default file name (without path) generated by the library for this resource.
resource_file_name_output	The overridden file name set by the caller, or None if no override was specified.
resource_file_uri	The default resource URI that the library would write into the Markdown output.
resource_file_uri_output	The overridden URI set by `UriSavingArgs.set_resource_file_uri`, or `None` if no override was specified.

Groupdocs API References – groupdocs.markdown

Python-Net: ConvertOptions class

ConvertOptions class

Constructors

Properties

See Also

Python-Net: ConvertResult class

ConvertResult class

Methods

Properties

See Also

Python-Net: CustomImageSavingArgs class

CustomImageSavingArgs class

Methods

Properties

See Also

Python-Net: CustomImagesStrategy class

CustomImagesStrategy class

Constructors

Methods

Properties

See Also

Python-Net: CustomUriExportStrategy class

CustomUriExportStrategy class

Constructors

Methods

See Also

Python-Net: DefaultUriExportStrategy class

DefaultUriExportStrategy class

Constructors

Methods

See Also

Python-Net: DocumentInfo class

DocumentInfo class

Properties

See Also

Python-Net: DocumentProtectedException class

DocumentProtectedException class

See Also

Python-Net: ExportImagesAsBase64Strategy class

ExportImagesAsBase64Strategy class

Constructors

Methods

Properties

See Also

Python-Net: ExportImagesToFileSystemStrategy class

ExportImagesToFileSystemStrategy class

Constructors

Methods

Properties

See Also

Python-Net: ExportOptions class

ExportOptions class

Constructors

Properties

See Also

Python-Net: FileFormat class

FileFormat class

Fields

See Also

Python-Net: GroupDocsMarkdownException class

GroupDocsMarkdownException class

See Also

Python-Net: IImageExportStrategy class

IImageExportStrategy class

Methods

Properties

See Also

Python-Net: IImageSavingHandler class

IImageSavingHandler class

Methods

See Also

Python-Net: IUriExportStrategy class

IUriExportStrategy class

Methods

See Also

Python-Net: IUriSavingHandler class

IUriSavingHandler class

Methods

See Also