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.

MarkdownConverter class