Index

B C D E I K L M S T U V W 
All Classes and Interfaces|All Packages|Serialized Form

B

build() - Method in class io.github.cyber655.markitdown.ConversionOptions.Builder
Builds the immutable options instance.
build() - Method in class io.github.cyber655.markitdown.MarkItDown.Builder
Builds an immutable client.
builder() - Static method in class io.github.cyber655.markitdown.ConversionOptions
Creates a new options builder.
builder() - Static method in class io.github.cyber655.markitdown.MarkItDown
Creates a new client builder.

C

charsetHint(String) - Method in class io.github.cyber655.markitdown.ConversionOptions.Builder
Hint about the file's charset, e.g.
contentUnderstanding(String) - Method in class io.github.cyber655.markitdown.ConversionOptions.Builder
Uses Azure Content Understanding for extraction (maps to --use-cu --cu-endpoint <endpoint>).
contentUnderstandingAnalyzer(String) - Method in class io.github.cyber655.markitdown.ConversionOptions.Builder
Content Understanding analyzer id (maps to --cu-analyzer).
contentUnderstandingFileTypes(String...) - Method in class io.github.cyber655.markitdown.ConversionOptions.Builder
File types to route to Content Understanding, e.g.
ConversionOptions - Class in io.github.cyber655.markitdown
Per-conversion options mapping directly onto the markitdown command-line flags.
ConversionOptions.Builder - Class in io.github.cyber655.markitdown
Builder for ConversionOptions.
convert(byte[], ConversionOptions) - Method in class io.github.cyber655.markitdown.MarkItDown
Converts in-memory bytes to Markdown by piping them to the tool's standard input.
convert(InputStream, ConversionOptions) - Method in class io.github.cyber655.markitdown.MarkItDown
Converts the contents of a stream to Markdown by piping them to standard input.
convert(Path) - Method in class io.github.cyber655.markitdown.MarkItDown
Converts a file to Markdown using default options.
convert(Path, ConversionOptions) - Method in class io.github.cyber655.markitdown.MarkItDown
Converts a file to Markdown.
convertToFile(Path, Path, ConversionOptions) - Method in class io.github.cyber655.markitdown.MarkItDown
Converts a file and writes the Markdown directly to output (maps to the CLI -o flag).
create() - Static method in class io.github.cyber655.markitdown.MarkItDown
Creates a client with default settings (markitdown on the PATH).

D

defaults() - Static method in class io.github.cyber655.markitdown.ConversionOptions
Returns a shared, empty options instance (no flags applied).
documentIntelligence(String) - Method in class io.github.cyber655.markitdown.ConversionOptions.Builder
Uses Azure Document Intelligence for extraction (maps to -d -e <endpoint>).

E

environment(String, String) - Method in class io.github.cyber655.markitdown.MarkItDown.Builder
Adds an environment variable for the subprocess (e.g.
executable(String) - Method in class io.github.cyber655.markitdown.MarkItDown.Builder
Path to (or name of) the markitdown executable.
exitCode() - Method in exception class io.github.cyber655.markitdown.MarkItDownException
The process exit code, or -1 if the failure occurred before/without a clean exit (for example, the executable was not found or the call timed out).
extensionHint(String) - Method in class io.github.cyber655.markitdown.ConversionOptions.Builder
Hint about the file extension (maps to -x).

I

io.github.cyber655.markitdown - package io.github.cyber655.markitdown
A Java API for Microsoft MarkItDown.
isAvailable() - Method in class io.github.cyber655.markitdown.MarkItDown
Returns true if the markitdown executable can be located and run, i.e.

K

keepDataUris(boolean) - Method in class io.github.cyber655.markitdown.ConversionOptions.Builder
Keeps data URIs (such as base64-encoded images) in the output instead of truncating them (maps to --keep-data-uris).

L

listPlugins() - Method in class io.github.cyber655.markitdown.MarkItDown
Returns the raw output of markitdown --list-plugins.

M

MarkItDown - Class in io.github.cyber655.markitdown
A Java API for Microsoft MarkItDown.
MarkItDown.Builder - Class in io.github.cyber655.markitdown
Builder for MarkItDown.
MarkItDownException - Exception Class in io.github.cyber655.markitdown
Thrown when a MarkItDown conversion fails: the markitdown executable could not be started, exited with a non-zero status, or timed out.
MarkItDownException(String) - Constructor for exception class io.github.cyber655.markitdown.MarkItDownException
Creates an exception with a message only.
MarkItDownException(String, int, String, Throwable) - Constructor for exception class io.github.cyber655.markitdown.MarkItDownException
Creates an exception describing a failed process invocation.
MarkItDownException(String, Throwable) - Constructor for exception class io.github.cyber655.markitdown.MarkItDownException
Creates an exception with a message and underlying cause.
mimeTypeHint(String) - Method in class io.github.cyber655.markitdown.ConversionOptions.Builder
Hint about the file's MIME type, e.g.

S

stderr() - Method in exception class io.github.cyber655.markitdown.MarkItDownException
The captured standard-error output of the process, or null if none was captured.

T

timeout(Duration) - Method in class io.github.cyber655.markitdown.MarkItDown.Builder
Maximum time to wait for a single conversion.

U

usePlugins(boolean) - Method in class io.github.cyber655.markitdown.ConversionOptions.Builder
Enables third-party MarkItDown plugins (maps to -p).
usePlugins(boolean) - Method in class io.github.cyber655.markitdown.MarkItDown.Builder
Enables third-party plugins for every conversion (maps to -p).

V

version() - Method in class io.github.cyber655.markitdown.MarkItDown
Returns the MarkItDown CLI version string (output of markitdown --version).

W

workingDirectory(Path) - Method in class io.github.cyber655.markitdown.MarkItDown.Builder
Working directory for the subprocess.
B C D E I K L M S T U V W 
All Classes and Interfaces|All Packages|Serialized Form