项目简介
MarkItDown是由微软开源的文档转换工具,可将多种格式文件转换为Markdown格式,便于本地阅读和处理。
核心特性
支持GitHub仓库克隆和转换
支持PDF、Word、PowerPoint等格式
本地运行,无需API Key
Apache-2.0开源协议
安装部署
系统要求
Python 3.8+
约500MB磁盘空间
网络访问GitHub(首次下载)
安装步骤
# 克隆仓库 git clone https://github.com/microsoft/MarkItDown.git cd MarkItDown # 创建虚拟环境 python -m venv venv source venv/bin/activate # Linux/Mac # 或 venv\Scripts\activate # Windows # 安装依赖 pip install -e .
使用方法
转换GitHub仓库
# 转换单个README markitdown https://github.com/microsoft/markitdown # 转换整个仓库 markitdown --recursive https://github.com/microsoft/markitdown
转换本地文件
# 转换PDF markitdown document.pdf # 转换Word文档 markitdown report.docx # 转换PowerPoint markitdown presentation.pptx
输出选项
# 输出到指定目录 markitdown input.md -o ./output/ # 保留图片链接 markitdown --images input.pdf # 递归处理目录 markitdown --recursive ./documents/
踩坑记录
坑1:大型仓库转换慢
递归转换大型仓库可能需要较长时间,建议分批处理。
坑2:图片下载失败
部分仓库的图片链接可能失效,使用--images参数时需检查网络。
坑3:中文PDF支持
某些中文PDF可能存在编码问题,建议使用最新版。
资源下载
官方直链
GitHub仓库:https://github.com/microsoft/MarkItDown
PyPI页面:https://pypi.org/project/markitdown/
文档站点:https://microsoft.github.io/MarkItDown/
许可证
Apache License 2.0
总结
MarkItDown是实用的本地文档转换工具,适合需要离线阅读GitHub文档或转换多种格式文件的用户。
参考资料:
- GitHub仓库:https://github.com/microsoft/MarkItDown
- PyPI:https://pypi.org/project/markitdown/