Method Convert

Namespace

LMKit.Document.Conversion

Assembly

LM-Kit.NET.dll

Convert(byte[], DocxToMarkdownOptions, CancellationToken)

Converts a DOCX document in memory to Markdown text.

public static string Convert(byte[] docxData, DocxToMarkdownOptions options = null, CancellationToken cancellation = default)

Parameters

docxData byte[]

The DOCX binary content.

options DocxToMarkdownOptions

Options controlling DOCX to Markdown conversion behavior.

cancellation CancellationToken

A cancellation token used to cancel the conversion operation.

Returns

string

The converted Markdown content.

Examples

using LMKit.Document.Conversion;

byte[] docxData = File.ReadAllBytes("report.docx");
string markdown = DocxToMarkdown.Convert(docxData, new DocxToMarkdownOptions
{
    IncludeTables = true,
    IncludeImages = false
});

File.WriteAllText("report.md", markdown);

Exceptions

ArgumentNullException

Thrown when docxData is null.

Convert(string, DocxToMarkdownOptions, CancellationToken)

Converts a DOCX file to Markdown text.

public static string Convert(string inputPath, DocxToMarkdownOptions options = null, CancellationToken cancellation = default)

Parameters

inputPath string

The DOCX file path to convert.

options DocxToMarkdownOptions

Options controlling DOCX to Markdown conversion behavior.

cancellation CancellationToken

A cancellation token used to cancel the conversion operation.

Returns

string

The converted Markdown content.

Examples

using LMKit.Document.Conversion;

string markdown = DocxToMarkdown.Convert("input/spec.docx", new DocxToMarkdownOptions
{
    PreserveLineBreaks = true
});

Console.WriteLine(markdown);