Groupdocs API References – MarkdownConverter class

Python-Net: init constructor

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

init

Initializes a new converter for the document at the specified file path.

The file format is detected automatically from the file extension and content.

def __init__(self, source_path):
    ...

Parameter	Type	Description
source_path	`str`	Absolute or relative path to the source document (e.g. `"report.docx"`).

Raises	Description
`ValueError`	When `source_path` is None or empty.
`FileNotFoundError`	When the file at `source_path` does not exist.
`NotImplementedError`	When the file format is not supported. Call `MarkdownConverter.get_supported_formats` to see which formats are accepted.

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.

def __init__(self, source_stream):
    ...

Parameter	Type	Description
source_stream	`io.RawIOBase`	A readable stream containing the document data. The stream is copied internally, so the caller may close it after construction.

Raises	Description
`ValueError`	When `source_stream` is None.
`NotImplementedError`	When the file format cannot be detected or is not supported.

init

Initializes a new converter for the document at the specified file path, using the given load options.

def __init__(self, source_path, load_options):
    ...

Parameter	Type	Description
source_path	`str`	Absolute or relative path to the source document.
load_options	`LoadOptions`	Options that control how the document is loaded. Pass a `LoadOptions` with `LoadOptions.password` set to open encrypted files, or with a specific `FileFormat` to override automatic format detection. May be None.

Raises	Description
`ValueError`	When `source_path` is None or empty.
`FileNotFoundError`	When the file at `source_path` does not exist.
`NotImplementedError`	When the file format is not supported.

init

Initializes a new converter that reads the document from the supplied stream, using the given load options.

Use this overload when reading from a io.BytesIO, network stream, or any non‑file stream where format detection from a file name is not available.

def __init__(self, source_stream, load_options):
    ...

Parameter	Type	Description
source_stream	`io.RawIOBase`	A readable stream containing the document data. The stream is copied internally, so the caller may close it after construction.
load_options	`LoadOptions`	Options that control how the document is loaded. Specify `LoadOptions.password` for encrypted files or a `FileFormat` to override automatic detection. May be `None`.

Raises	Description
`ValueError`	If `source_stream` is `None`.
`NotImplementedError`	If the file format cannot be detected or is not supported.

Python-Net: convert method

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

convert

Converts the loaded document to Markdown using default options and returns the result with the Markdown content in ConvertResult.content.

def convert(self):
    ...

Returns: A ConvertResult whose ConvertResult.is_success indicates whether the conversion succeeded. On success, ConvertResult.content contains the Markdown string.

convert

Converts the loaded document to Markdown and writes the output to the specified stream.

The ConvertResult.content property will be None; the Markdown bytes are written directly to output_stream.

def convert(self, output_stream):
    ...

Parameter	Type	Description
output_stream	`io.RawIOBase`	A writable stream that will receive the UTF-8 encoded Markdown output.

Returns: ConvertResult: A ConvertResult indicating success or failure. On success, ConvertResult.content is None because the output was written to the stream.

convert

Converts the loaded document to Markdown and saves the result to a file at the specified output_file_path.

def convert(self, output_file_path):
    ...

Parameter	Type	Description
output_file_path	`str`	The path where the Markdown file will be written.

Returns: ConvertResult: A ConvertResult indicating success or failure. On success, ConvertResult.Content is None because the output was written to the file.

convert

Converts the loaded document to Markdown with the specified options and returns the result with the Markdown content in ConvertResult.content.

def convert(self, convert_options):
    ...

Parameter	Type	Description
convert_options	`ConvertOptions`	Options that control the conversion, such as `ConvertOptions.heading_level_offset`, `ConvertOptions.image_export_strategy`, and `ConvertOptions.page_numbers`. Pass `None` to use defaults.

Returns: A ConvertResult whose ConvertResult.content contains the Markdown string on success.

convert

Converts the loaded document to Markdown with the specified options, writing the output to a stream.

def convert(self, output_stream, convert_options):
    ...

Parameter	Type	Description
output_stream	`io.RawIOBase`	A writable stream that will receive the UTF-8 encoded Markdown output.
convert_options	`ConvertOptions`	Options that control the conversion. Pass `None` to use defaults.

Returns: A ConvertResult indicating success or failure. ConvertResult.content is None because the output was written to the stream.

convert

Converts the loaded document to Markdown with the specified options and saves the result to a file.

def convert(self, output_file_path, convert_options):
    ...

Parameter	Type	Description
output_file_path	`str`	The path where the Markdown file will be written.
convert_options	`ConvertOptions`	Options that control the conversion. Pass `None` to use defaults.

Returns: ConvertResult: A ConvertResult indicating success or failure. ConvertResult.content is None because the output was written to the file.

Python-Net: convert_async method

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

convert_async

Asynchronously converts the loaded document to Markdown and returns the result as a string.

def convert_async(self):
    ...

Returns: str: The converted Markdown content.

convert_async

Asynchronously converts the loaded document to Markdown with the specified options.

def convert_async(self, convert_options):
    ...

Parameter	Type	Description
convert_options	`ConvertOptions`	Options that control the conversion.

convert_async

Asynchronously converts the loaded document and saves the result to a file.

def convert_async(self, output_file_path, convert_options):
    ...

Parameter	Type	Description
output_file_path	`str`	The path where the Markdown file will be written.
convert_options	`ConvertOptions`	Options that control the conversion. Pass `None` for defaults.

Python-Net: from_markdown method

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

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).

def from_markdown(cls, markdown_path, output_path):
    ...

Parameter	Type	Description
markdown_path	`str`	Path to the source Markdown file.
output_path	`str`	Path where the output document will be saved. The extension determines the format.

Raises	Description
`GroupDocsMarkdownException`	Thrown when conversion fails.
`NotImplementedError`	Thrown when the output format is not supported.

from_markdown

Converts a Markdown file to a document format with the specified export options.

def from_markdown(cls, markdown_path, output_path, options):
    ...

Parameter	Type	Description
markdown_path	`str`	Path to the source Markdown file.
output_path	`str`	Path where the output document will be saved.
options	`ExportOptions`	Export options. Use `ExportOptions.format` to override format detection, or pass `None` to infer from the output file extension.

Raises	Description
`GroupDocsMarkdownException`	Thrown when conversion fails.
`NotImplementedError`	Thrown when the output format is not supported.

Python-Net: from_markdown_string method

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

from_markdown_string

Converts a Markdown string to a document and saves it to a file.

def from_markdown_string(cls, markdown_content, output_path, options):
    ...

Parameter	Type	Description
markdown_content	`str`	The Markdown content as a string.
output_path	`str`	Path where the output document will be saved.
options	`ExportOptions`	Export options, or `None` to infer format from the file extension.

Raises	Description
`GroupDocsMarkdownException`	Thrown when conversion fails.
`NotImplementedError`	Thrown when the output format is not supported.

from_markdown_string

Converts a Markdown string to a document and writes it to a stream.

def from_markdown_string(cls, markdown_content, output_stream, options):
    ...

Parameter	Type	Description
markdown_content	`str`	The Markdown content as a string.
output_stream	`io.RawIOBase`	A writable stream that will receive the document bytes.
options	`ExportOptions`	Export options. `ExportOptions.format` must be set since there is no file extension to infer from.

Raises	Description
`GroupDocsMarkdownException`	Thrown when conversion fails.
`ValueError`	Thrown when `options` is None or `ExportOptions.format` is `FileFormat.unknown`.

Python-Net: get_document_info method

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

get_document_info

Retrieves metadata about the loaded document without performing a full conversion.

def get_document_info(self):
    ...

Returns: DocumentInfo: A DocumentInfo containing the detected FileFormat, PageCount, Title, Author, and IsEncrypted flag.

Python-Net: get_document_info_async method

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

get_document_info_async

Asynchronously retrieves metadata about the loaded document.

def get_document_info_async(self):
    ...

Python-Net: get_info method

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

get_info

Returns metadata about a document (format, page count, title, author, encryption status) without performing a full conversion.

def get_info(cls, source_path):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.

Returns: DocumentInfo: A DocumentInfo with the detected format, page count, and other metadata.

Raises	Description
`ValueError`	When `source_path` is None or empty.
`NotImplementedError`	When the file format is not supported.

get_info

Returns metadata about a document using the specified load options. Use this overload to supply a password when inspecting an encrypted document.

def get_info(cls, source_path, load_options):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.
load_options	`LoadOptions`	Options for loading the document (password, format hint). May be None.

Returns: DocumentInfo: The detected format, page count, and other metadata.

Raises	Description
`ValueError`	When `source_path` is None or empty.
`NotImplementedError`	When the file format is not supported.

Python-Net: get_info_async method

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

get_info_async

Asynchronously retrieves metadata about the document at the specified path.

def get_info_async(cls, source_path, load_options):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.
load_options	`LoadOptions`	Options for loading the document. May be None.

Python-Net: get_supported_formats method

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

get_supported_formats

Returns the complete list of FileFormat values that can be converted to Markdown.

Use this to check at runtime whether a particular format is supported before attempting conversion.

def get_supported_formats(cls):
    ...

Returns: list[FileFormat]: A read-only list of all supported FileFormat values.

Python-Net: to_file method

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

to_file

Converts a document to Markdown and saves the result directly to a file.

def to_file(cls, source_path, output_path):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document (e.g. `"report.pdf"`).
output_path	`str`	The path where the Markdown file will be created or overwritten.

Raises	Description
`GroupDocsMarkdownException`	Thrown when the conversion fails.
`ValueError`	Thrown when `source_path` is None or empty.
`NotImplementedError`	Thrown when the file format is not supported.

to_file

Converts a document to Markdown with the specified conversion options and saves the result to a file.

def to_file(cls, source_path, output_path, convert_options):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.
output_path	`str`	The path where the Markdown file will be created or overwritten.
convert_options	`ConvertOptions`	Options that customize the conversion (image strategy, heading offset, page numbers). May be `None`.

Raises	Description
`GroupDocsMarkdownException`	Thrown when the conversion fails.
`NotImplementedError`	Thrown when the file format is not supported.

to_file

Converts a document to Markdown with the specified load and conversion options, saving the result to a file.

def to_file(cls, source_path, output_path, load_options, convert_options):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.
output_path	`str`	The path where the Markdown file will be created or overwritten.
load_options	`LoadOptions`	Options for loading the document (password, format hint). May be None.
convert_options	`ConvertOptions`	Options that customize the conversion. May be None.

Raises	Description
`GroupDocsMarkdownException`	Thrown when the conversion fails.
`NotImplementedError`	Thrown when the file format is not supported.

Python-Net: to_file_async method

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

to_file_async

Asynchronously converts the document and saves the result to a file.

Both source reading and output writing are performed asynchronously.

def to_file_async(cls, source_path, output_path, convert_options):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.
output_path	`str`	The path where the Markdown file will be saved.
convert_options	`ConvertOptions`	Options for the conversion. May be None.

Raises	Description
`GroupDocsMarkdownException`	Thrown when conversion fails.

Python-Net: to_markdown method

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

to_markdown

Converts a document to Markdown in a single call and returns the Markdown string.

def to_markdown(cls, source_path):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document (e.g. `"report.docx"`).

Returns: str: The converted Markdown content as a UTF-8 string.

Raises	Description
`GroupDocsMarkdownException`	Thrown when the conversion fails.
`ValueError`	Thrown when `source_path` is None or empty.
`NotImplementedError`	Thrown when the file format is not supported.

to_markdown

Converts a document to Markdown using the specified load options and returns the Markdown string.

Use this overload to supply a password for encrypted documents or to specify the file format explicitly.

def to_markdown(cls, source_path, load_options):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.
load_options	`LoadOptions`	Options for loading the document (password, format hint). May be None.

Returns: str: The converted Markdown content as a UTF-8 string.

Raises	Description
`GroupDocsMarkdownException`	Thrown when the conversion fails.
`NotImplementedError`	Thrown when the file format is not supported.

to_markdown

Converts a document to Markdown using the specified conversion options and returns the Markdown string.

Use this overload to control image handling, heading offsets, or page selection.

def to_markdown(cls, source_path, convert_options):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.
convert_options	`ConvertOptions`	Options that customize the conversion (image strategy, heading offset, page numbers). May be None.

Returns: str: The converted Markdown content as a UTF-8 string.

Raises	Description
`GroupDocsMarkdownException`	Thrown when the conversion fails.
`NotImplementedError`	Thrown when the file format is not supported.

to_markdown

Converts a document to Markdown using the specified load and conversion options, and returns the Markdown string.

def to_markdown(cls, source_path, load_options, convert_options):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.
load_options	`LoadOptions`	Options for loading the document (password, format hint). May be None.
convert_options	`ConvertOptions`	Options that customize the conversion. May be None.

Returns: str: The converted Markdown content as a UTF-8 string.

Raises	Description
`NotImplementedError`	Thrown when the file format is not supported.

Python-Net: to_markdown_async method

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

to_markdown_async

Asynchronously converts the document at the specified path to Markdown. File reading is performed asynchronously.

def to_markdown_async(cls, source_path):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.

Returns: str: The converted Markdown content.

Raises	Description
`GroupDocsMarkdownException`	Thrown when conversion fails.

to_markdown_async

Asynchronously converts the document at the specified path to Markdown.

def to_markdown_async(cls, source_path, load_options, convert_options):
    ...

Parameter	Type	Description
source_path	`str`	The path to the source document.
load_options	`LoadOptions`	Options for loading the document. May be None.
convert_options	`ConvertOptions`	Options for the conversion. May be None.

Returns: str: The converted Markdown content.

Raises	Description
`GroupDocsMarkdownException`	Thrown when conversion fails.

Groupdocs API References – MarkdownConverter class

Python-Net: __init__ constructor

init

init

init

init

See Also

Python-Net: convert method

convert

convert

convert

convert

convert

convert

See Also

Python-Net: convert_async method

convert_async

convert_async

convert_async

See Also

Python-Net: from_markdown method

from_markdown

from_markdown

See Also

Python-Net: from_markdown_string method

from_markdown_string

from_markdown_string

See Also

Python-Net: get_document_info method

get_document_info

See Also

Python-Net: get_document_info_async method

get_document_info_async

See Also

Python-Net: get_info method

get_info

get_info

See Also

Python-Net: get_info_async method

get_info_async

See Also

Python-Net: get_supported_formats method

get_supported_formats

See Also

Python-Net: to_file method

to_file

to_file

to_file

See Also

Python-Net: to_file_async method

to_file_async

See Also

Python-Net: to_markdown method

to_markdown

to_markdown

to_markdown

to_markdown

See Also

Python-Net: to_markdown_async method

to_markdown_async

to_markdown_async

See Also

Python-Net: init constructor