基础使用#

命令行的使用方法如下，使用 > 或者 -o 指定输出文件路径

markitdown path/to/file.pdf > document.md

markitdown path/to/file.pptx -o document.md

此外，还可以通过管道的方式转换文档

# Linux 或 macOS
cat path/to/file.docx | markitdown > document.md

# Windows PowerShell - 不推荐使用
Get-Content path/to/file.docx | markitdown > document.md

插件#

MarkItDown 还支持第三方的插件，可以通过安装第三方插件来扩展其功能。下面指令列举了已安装的插件

markitdown --list-plugins

可以用这个指令启用插件

markitdown --use-plugins path/to/file.pdf

markitdown-ocr 插件

markitdown-ocr 插件为 PDF、DOCX、PPTX 和 XLSX 文件增加了 OCR 识别功能。为了使用这个插件，需要额外安装以下依赖

pip install markitdown-ocr
pip install openai  # 或者其他与 OpenAI API 兼容的库

使用方法如下

from markitdown import MarkItDown
from openai import OpenAI

# 转换是基于 LLM 的，因此需要提供一个 LLM 客户端实例
md = MarkItDown(
    enable_plugins=True,
    llm_client=OpenAI(),
    llm_model="gpt-4o",
)
result = md.convert("document_with_images.pdf")
print(result.text_content)

# 保存为 Markdown 文件
with open("document.md", "w", encoding="utf-8") as f:
    f.write(result.markdown_content)

Azure 文档数据提取器#

亦可以集成到这个工具中来使用

markitdown path-to-file.pdf -o document.md -d -e "<document_intelligence_endpoint>"

Python 接口#

基础 Python 接口的使用方法如下

from markitdown import MarkItDown

md = MarkItDown(enable_plugins=False)   # 设置为 False 来禁用插件
result = md.convert("test.xlsx")
print(result.text_content)

结合 Azure 文档数据提取器的使用方法如下

from markitdown import MarkItDown

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

如果想利用大模型的能力提取图像中的文本，可以提供 llm_client 和 llm_model 参数来启用 OCR 插件

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)