MarkItDown - 文件转Markdown转换器

MarkItDown - 文件转Markdown转换器 是做什么的？

概述

MarkItDown 是微软开发的Python工具，用于将各种文件格式转换为Markdown。该工具特别适合将文档转换为LLM友好的文本格式，因为Markdown对Token利用高效且能被现代语言模型很好理解。

主要优势：

• 将文档转换为清晰、结构化的Markdown
• 对LLM处理而言，Token效率高的格式
• 支持15种以上文件格式
• 可选AI增强图片描述
• 支持图片和扫描文档的OCR
• 支持音频文件的语音转录

科学示意图增强视觉呈现

使用此技能创建文档时，请始终考虑添加科学图表和示意图以增强视觉沟通效果。

如果您的文档尚未包含示意图或图表：

• 使用 scientific-schematics 技能生成AI驱动的出版级图表
• 只需用自然语言描述您想要的图表
• Nano Banana Pro 将自动生成、审查并完善示意图

对于新文档： 应默认生成科学示意图，以直观展示文中描述的关键概念、工作流程、架构或关系。

如何生成示意图：

python scripts/generate_schematic.py "您的图表描述" -o figures/output.png

AI将自动：

• 创建格式得当的出版级图片
• 经过多次迭代审查和完善
• 确保可访问性（色盲友好、高对比度）
• 将输出保存在 figures/ 目录下

何时添加示意图：

• 文档转换工作流图
• 文件格式架构图
• OCR处理流水线图
• 集成工作流程图
• 系统架构图
• 数据流图
• 任何受益于可视化的复杂概念

有关创建示意图的详细指南，请参阅 scientific-schematics 技能文档。

---

支持的格式

格式	描述	备注
PDF	便携式文档格式	全文提取
DOCX	Microsoft Word	保留表格、格式
PPTX	PowerPoint	带注释的幻灯片
XLSX	Excel 电子表格	表格和数据
图片	JPEG, PNG, GIF, WebP	EXIF元数据 + OCR
音频	WAV, MP3	元数据 + 转录
HTML	网页	干净的转换
CSV	逗号分隔值	表格格式
JSON	JSON数据	结构化表示
XML	XML文档	结构化格式
ZIP	压缩文件	迭代遍历内容
EPUB	电子书	全文提取
YouTube	视频链接	获取字幕

快速开始

安装

# 安装全部功能
pip install 'markitdown[all]'

# 或从源码安装
git clone https://github.com/microsoft/markitdown.git
cd markitdown
pip install -e 'packages/markitdown[all]'

命令行用法

# 基本转换
markitdown document.pdf > output.md

# 指定输出文件
markitdown document.pdf -o output.md

# 管道内容
cat document.pdf | markitdown > output.md

# 启用插件
markitdown --list-plugins  # 列出可用插件
markitdown --use-plugins document.pdf -o output.md

Python API

from markitdown import MarkItDown

# 基本用法
md = MarkItDown()
result = md.convert("document.pdf")
print(result.text_content)

# 从流转换
with open("document.pdf", "rb") as f:
    result = md.convert_stream(f, file_extension=".pdf")
    print(result.text_content)

高级功能

1. AI增强图片描述

通过OpenRouter使用LLM生成详细的图片描述（适用于PPTX和图片文件）：

from markitdown import MarkItDown
from openai import OpenAI

# 初始化OpenRouter客户端（兼容OpenAI API）
client = OpenAI(
    api_key="your-openrouter-api-key",
    base_url="https://openrouter.ai/api/v1"
)

md = MarkItDown(
    llm_client=client,
    llm_model="anthropic/claude-sonnet-4.5",  # 推荐用于科学视觉理解
    llm_prompt="详细描述此图片内容，用于科学文档"
)

result = md.convert("presentation.pptx")
print(result.text_content)

2. Azure文档智能

使用Microsoft文档智能服务增强PDF转换：

# 命令行
markitdown document.pdf -o output.md -d -e "<document_intelligence_endpoint>"

# Python API
from markitdown import MarkItDown

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

3. 插件系统

MarkItDown支持第三方插件扩展功能：

# 列出已安装插件
markitdown --list-plugins

# 启用插件
markitdown --use-plugins file.pdf -o output.md

在GitHub上使用标签 #markitdown-plugin 查找插件

可选依赖项

控制您支持的文件格式：

# 安装特定格式支持
pip install 'markitdown[pdf, docx, pptx]'

# 所有可选选项：
# [all]                  - 所有可选依赖项
# [pptx]                 - PowerPoint文件
# [docx]                 - Word文档
# [xlsx]                 - Excel电子表格
# [xls]                  - 旧版Excel文件
# [pdf]                  - PDF文档
# [outlook]              - Outlook邮件
# [az-doc-intel]         - Azure文档智能
# [audio-transcription]  - WAV和MP3转录
# [youtube-transcription] - YouTube视频转录

常见用例

1. 将科学论文转换为Markdown

from markitdown import MarkItDown

md = MarkItDown()

# 转换PDF论文
result = md.convert("research_paper.pdf")
with open("paper.md", "w") as f:
    f.write(result.text_content)

2. 从Excel提取数据用于分析

from markitdown import MarkItDown

md = MarkItDown()
result = md.convert("data.xlsx")

# 结果将采用Markdown表格格式
print(result.text_content)

3. 处理多个文档

from markitdown import MarkItDown
import os
from pathlib import Path

md = MarkItDown()

# 处理目录中的所有PDF
pdf_dir = Path("papers/")
output_dir = Path("markdown_output/")
output_dir.mkdir(exist_ok=True)

for pdf_file in pdf_dir.glob("*.pdf"):
    result = md.convert(str(pdf_file))
    output_file = output_dir / f"{pdf_file.stem}.md"
    output_file.write_text(result.text_content)
    print(f"已转换：{pdf_file.name}")

4. 使用AI描述转换PowerPoint

from markitdown import MarkItDown
from openai import OpenAI

# 使用OpenRouter访问多种AI模型
client = OpenAI(
    api_key="your-openrouter-api-key",
    base_url="https://openrouter.ai/api/v1"
)

md = MarkItDown(
    llm_client=client,
    llm_model="anthropic/claude-sonnet-4.5",  # 推荐用于演示文稿
    llm_prompt="详细描述此幻灯片图片，重点关注关键视觉元素和数据"
)

result = md.convert("presentation.pptx")
with open("presentation.md", "w") as f:
    f.write(result.text_content)

5. 批量转换不同格式

from markitdown import MarkItDown
from pathlib import Path

md = MarkItDown()

# 待转换的文件
files = [
    "document.pdf",
    "spreadsheet.xlsx",
    "presentation.pptx",
    "notes.docx"
]

for file in files:
    try:
        result = md.convert(file)
        output = Path(file).stem + ".md"
        with open(output, "w") as f:
            f.write(result.text_content)
        print(f"✓ 已转换 {file}")
    except Exception as e:
        print(f"✗ 转换 {file} 时出错：{e}")

6. 提取YouTube视频转录

from markitdown import MarkItDown

md = MarkItDown()

# 将YouTube视频转换为转录文本
result = md.convert("https://www.youtube.com/watch?v=VIDEO_ID")
print(result.text_content)

Docker用法

# 构建镜像
docker build -t markitdown:latest .

# 运行转换
docker run --rm -i markitdown:latest < ~/document.pdf > output.md

最佳实践

1. 选择合适的转换方法

• 简单文档：使用基本的 MarkItDown()
• 复杂PDF：使用Azure文档智能
• 视觉内容：启用AI图片描述
• 扫描文档：确保已安装OCR依赖项

2. 优雅地处理错误

from markitdown import MarkItDown

md = MarkItDown()

try:
    result = md.convert("document.pdf")
    print(result.text_content)
except FileNotFoundError:
    print("未找到文件")
except Exception as e:
    print(f"转换错误：{e}")

3. 高效处理大文件

from markitdown import MarkItDown

md = MarkItDown()

# 对于大文件，使用流式处理
with open("large_file.pdf", "rb") as f:
    result = md.convert_stream(f, file_extension=".pdf")
    
    # 分块处理或直接保存
    with open("output.md", "w") as out:
        out.write(result.text_content)

4. 优化Token效率

Markdown输出本身已对Token友好，但您可以：

• 移除多余空白
• 合并相似章节
• 如果不需要，去除元数据

from markitdown import MarkItDown
import re

md = MarkItDown()
result = md.convert("document.pdf")

# 清理多余空白
clean_text = re.sub(r'\n{3,}', '\n\n', result.text_content)
clean_text = clean_text.strip()

print(clean_text)

与科学工作流集成

转换文献用于综述

from markitdown import MarkItDown
from pathlib import Path

md = MarkItDown()

# 转换literature文件夹中的所有论文
papers_dir = Path("literature/pdfs")
output_dir = Path("literature/markdown")
output_dir.mkdir(exist_ok=True)

for paper in papers_dir.glob("*.pdf"):
    result = md.convert(str(paper))
    
    # 保存并附带元数据
    output_file = output_dir / f"{paper.stem}.md"
    content = f"# {paper.stem}\n\n"
    content += f"**来源**：{paper.name}\n\n"
    content += "---\n\n"
    content += result.text_content
    
    output_file.write_text(content)

# AI增强转换（含图表）
from openai import OpenAI

client = OpenAI(
    api_key="your-openrouter-api-key",
    base_url="https://openrouter.ai/api/v1"
)

md_ai = MarkItDown(
    llm_client=client,
    llm_model="anthropic/claude-sonnet-4.5",
    llm_prompt="以技术精度描述科学图表"
)

提取表格用于分析

from markitdown import MarkItDown
import re

md = MarkItDown()
result = md.convert("data_tables.xlsx")

# Markdown表格可以直接解析或使用
print(result.text_content)

故障排除

常见问题

1. 缺少依赖项：安装特定功能的包

   pip install 'markitdown[pdf]'  # 确保PDF支持
   

2. 二进制文件错误：确保以二进制模式打开文件

   with open("file.pdf", "rb") as f:  # 注意 "rb"
       result = md.convert_stream(f, file_extension=".pdf")
   

3. OCR不工作：安装tesseract

   # macOS
   brew install tesseract
   
   # Ubuntu
   sudo apt-get install tesseract-ocr
   

性能考量

• PDF文件：大型PDF可能需要时间；如果支持，可考虑页范围
• 图片OCR：OCR处理对CPU要求高
• 音频转录：需要额外的计算资源
• AI图片描述：需要API调用（可能产生费用）

下一步

• 参见 references/api_reference.md 获取完整API文档
• 查看 references/file_formats.md 了解格式特定细节
• 阅读 scripts/batch_convert.py 获取自动化示例
• 探索 scripts/convert_with_ai.py 获取AI增强转换

资源

• MarkItDown GitHub：https://github.com/microsoft/markitdown
• PyPI：https://pypi.org/project/markitdown/
• OpenRouter：https://openrouter.ai （用于AI增强转换）
• OpenRouter API密钥：https://openrouter.ai/keys
• OpenRouter模型：https://openrouter.ai/models
• MCP服务器：markitdown-mcp （用于Claude Desktop集成）
• 插件开发：参见 packages/markitdown-sample-plugin