MarkItDown 项目使用教程

MarkItDown 项目使用教程

markitdown Python tool for converting files and office documents to Markdown. 项目地址: https://gitcode.com/gh_mirrors/ma/markitdown

1. 项目目录结构及介绍

MarkItDown 项目是一个由微软开发的 Python 实用工具，用于将各种文件格式转换为 Markdown 格式。以下是项目的目录结构及各部分的简要介绍：

• packages/：包含 MarkItDown 的 Python 包和相关依赖。
• tests/：包含对 MarkItDown 进行单元测试的代码。
• .github/：包含 GitHub Actions 工作流程和其他 GitHub 相关配置文件。
• .gitignore：指定 Git 忽略的文件和目录。
• CODE_OF_CONDUCT.md：项目的行为准则。
• Dockerfile：用于构建 MarkItDown 的 Docker 容器的配置文件。
• LICENSE：项目的许可证文件，MarkItDown 采用 MIT 许可证。
• README.md：项目的自述文件，包含项目介绍、安装和使用说明。
• SECURITY.md：安全策略文件，描述如何报告安全漏洞。
• SUPPORT.md：支持文件，提供有关如何获取帮助的信息。

2. 项目的启动文件介绍

MarkItDown 的启动主要是通过命令行界面（CLI）进行的。以下是主要的启动文件和脚本：

• markitdown.py：MarkItDown 的主 Python 脚本文件，用于解析命令行参数并启动转换流程。
• setup.py：Python 包的设置文件，用于安装 MarkItDown 及其依赖。

在命令行中，可以通过以下命令使用 MarkItDown：

markitdown path-to-file.pdf

或者指定输出文件：

markitdown path-to-file.pdf -o document.md

3. 项目的配置文件介绍

MarkItDown 的配置主要是通过环境变量和命令行参数进行的。以下是一些主要的配置选项：

• MARKITDOWN_PLUGINS：环境变量，用于指定要加载的插件。
• MARKITDOWN_ENDPOINT：环境变量，用于指定文档智能服务的终端点。
• MARKITDOWN_LLM_CLIENT 和 MARKITDOWN_LLM_MODEL：环境变量，用于配置大型语言模型客户端和模型。

在 Python API 使用中，可以通过以下方式配置 MarkItDown：

from markitdown import MarkItDown
md = MarkItDown(enable_plugins=False)  # 设置为 True 以启用插件
result = md.convert("test.xlsx")
print(result.text_content)

对于更高级的配置，如使用 Azure Document Intelligence 或其他大型语言模型，可以在初始化 MarkItDown 类时传递相应的参数。

markitdown Python tool for converting files and office documents to Markdown. 项目地址: https://gitcode.com/gh_mirrors/ma/markitdown