GroupDocs.Markdown

The GroupDocs.Markdown namespace provides classes for converting documents to Markdown format and exporting Markdown to other document formats.

Classes

Class Description
ConvertOptions Provides options for customizing the document conversion process to Markdown format.
ConvertResult Contains the output of a successful document-to-Markdown conversion.
CustomImageSavingArgs 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.
CustomImagesStrategy Implements an image export strategy that gives you full control over how images are saved during conversion.
CustomUriExportStrategy Implements a URI export strategy that lets you customize how resource URIs are written to Markdown.
DefaultUriExportStrategy Provides default URI handling that keeps the URIs generated by the library unchanged.
DocumentInfo Provides read-only metadata about a loaded document, such as its format, page count, title, and encryption status.
DocumentProtectedException The exception that is thrown when a document is password-protected and no password (or an incorrect password) was provided via Password.
ExportImagesAsBase64Strategy Implements an image export strategy that embeds images as Base64 strings directly in the Markdown.
ExportImagesToFileSystemStrategy Saves images to a folder on disk during conversion.
ExportOptions Options for exporting Markdown to a document format (reverse conversion).
GroupDocsMarkdownException Represents a product-specific exception that is thrown during file processing.
ImageExportContext Contains read-only information about a single image encountered during conversion. Passed to GetImageStream.
InvalidFormatException The exception that is thrown when a file has an invalid format.
License Provides methods to license the component. Learn more about licensing here.
LoadOptions Specifies additional options for loading a document, such as an explicit file format or a password for encrypted files.
MarkdownConverter Converts documents from Word, Excel, PDF, and other formats to Markdown. Provides both static one-liner methods and an instance-based API with full control over conversion options.
Metered Provides methods for applying Metered license.
SkipImagesStrategy Implements an image export strategy that skips saving images during document conversion.
UriExportContext Contains information about a resource URI being written during conversion. Passed to UpdateResourceUri.
UriSavingArgs Provides information and controls for customizing how a resource URI is written during document-to-Markdown conversion. An instance of this class is created for each resource and can be used to override the default URI or file name.

Interfaces

Interface Description
IImageExportStrategy Defines a strategy for handling image export during document-to-Markdown conversion. Implement this interface to control where and how images extracted from the source document are stored.
IImageSavingHandler 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.
IUriExportStrategy Defines a strategy for customizing resource URIs that are written into the Markdown output during conversion.
IUriSavingHandler Callback interface invoked for each resource URI during conversion when using CustomUriExportStrategy. Implement this interface to rewrite resource URIs in the Markdown output.

Enumeration

Enumeration Description
FileFormat 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).
MarkdownFlavor Specifies the target Markdown dialect for the conversion output.