microsoft-markitdown（microsoft MarkItDown 文档）

Microsoft MarkItDown

A Python tool for converting various file types to Markdown format.

Use Cases

Use this skill when users mention scenarios like "convert file to Markdown," "extract document content," "file to Markdown," or "extract text from PDF/Word/Excel."

Installation

pip install 'markitdown[all]'

Optional dependency group installations (to save space):

Command Line Usage

# Basic usage: output to stdout
markitdown path-to-file.pdf > document.md

# Specify output file
markitdown path-to-file.pdf -o document.md

# Pipe input
cat path-to-file.pdf | markitdown

# Use Azure Document Intelligence
markitdown path-to-file.pdf -o document.md -d -e "<document_intelligence_endpoint>"

# List installed plugins
markitdown --list-plugins

# Enable plugins
markitdown --use-plugins path-to-file.pdf

Python API Usage

from markitdown import MarkItDown

md = MarkItDown(enable_plugins=False)  # True to enable plugins
result = md.convert("test.xlsx")
print(result.text_content)

With LLM Image Description (Only supports pptx and image files)

from markitdown import MarkItDown
from openai import OpenAI

client = OpenAI()
md = MarkItDown(llm_client=client, llm_model="gpt-4o", llm_prompt="optional custom prompt")
result = md.convert("example.jpg")
print(result.text_content)

With Azure Document Intelligence

from markitdown import MarkItDown

md = MarkItDown(docintel_endpoint="<document_intelligence_endpoint>")
result = md.convert("test.pdf")
print(result.text_content)

Using markitdown-ocr Plugin (OCR for Images Embedded in PDF/DOCX/PPTX/XLSX)

from markitdown import MarkItDown
from openai import OpenAI

md = MarkItDown(
    enable_plugins=True,
    llm_client=OpenAI(),
    llm_model="gpt-4o",
)
result = md.convert("document_with_images.pdf")
print(result.text_content)

Supported Formats Overview

Agent Execution Workflow

When a user requests file conversion:

1. Confirm Input File: Obtain the file path.
2. Install Dependencies: Check if markitdown is installed and suggest installing corresponding dependencies based on the file type if needed.
3. Execute Conversion:

- Command line: markitdown <file> -o <output.md> - Or Python API.

1. Return Result: Output the Markdown content or the saved file path.

Notes

• Python 3.10+ is required.
• Using a virtual environment is recommended to avoid dependency conflicts.
• The OCR plugin requires an LLM API Key (e.g., OpenAI).
• Azure Document Intelligence requires an Azure account configuration.