Project-to-Markdown Packer (项目打包为Markdown工具)

一个简单但强大的图形化桌面工具，用于将整个项目文件夹打包成一个结构化的、适合提供给AI大语言模型（如 GPT、Gemini、Claude 等）的单一 Markdown 文件。

解决什么问题？

当我们需要让AI辅助我们完成复杂的项目任务时（例如代码审查、添加新功能、生成文档或查找错误），通常需要提供项目的完整上下文。手动一个个上传文件不仅效率低下，而且容易遗漏关键信息，同时还会受到模型的上传文件数量限制。

本工具通过将所有相关代码和文本文件合并成一个条理清晰的 Markdown 文件，极大地简化了这一过程。你只需上传这一个文件，AI 就能获得项目的全貌。

✨ 主要功能

• 图形化用户界面 (GUI): 无需任何命令行操作，通过直观的窗口完成所有设置。
• 高度可定制:
  • 自由选择文件类型: 在打包前，可以自由勾选需要包含内容的文件类型。
  • 预设管理: 可将常用的文件类型组合保存为预设（例如 "Python后端项目"、"React前端项目"），方便一键加载，提高效率。
• 自动生成项目文件树: 在 Markdown 文件的最开始，会自动生成一个清晰的目录结构树，帮助AI和人类快速理解项目布局。
• 智能忽略: 默认会自动忽略 .git, node_modules, __pycache__ 等无需包含的目录和文件，保持输出内容的干净和聚焦。
• 语法高亮支持: 根据文件后缀名，为 Markdown 中的代码块自动添加语言标识符（如 python, javascript），在兼容的阅读器中获得更好的可读性。
• 跨平台: 基于 Python 和 Tkinter 构建，可在 Windows, macOS 和 Linux 上无缝运行。

🎬 快速上手

1. 环境要求

• 确保你的电脑已经安装了 Python 3。
• 本工具使用 Tkinter 作为图形界面库，通常在 Windows 和 macOS 的标准 Python 安装中已自带，Linux 用户可能需要通过包管理器手动安装 (sudo apt-get install python3-tk)。

2. 如何运行

1. 下载本项目中的 .py 脚本文件到你的电脑上。
2. 通过终端或命令行运行脚本：

   python Project-to-Markdown-Packer.py 

3. 使用步骤

1. 选择文件类型: 运行脚本后，会弹出一个窗口。请在此勾选你希望打包其内容的文件后缀名。 2. (可选) 使用预设:
   • 保存预设: 在 "另存为" 输入框中为当前的选择方案命名，然后点击 "保存" 按钮。
   • 加载预设: 从 "加载预设" 下拉菜单中选择一个之前保存的方案，即可快速应用。
2. 确认并选择文件夹: 点击 "确定" 后，会弹出文件浏览器，请选择你想要打包的 项目根文件夹。
3. 完成! 程序会自动处理并在完成后弹出成功提示。最终生成的 .md 文件会保存在你所选文件夹的 上一级目录 中，并与该文件夹同名。

🔧 自定义配置

如果你想进行更深度的自定义，可以直接编辑脚本的 --- 配置区 --- 部分：

• CANDIDATE_EXTENSIONS: 修改此列表可以增删在选择窗口中出现的 文件后缀名选项。
• LANGUAGE_MAP: 在此字典中添加新的 后缀名: 语言标识符 键值对，以支持更多语言的 语法高亮。
• IGNORED_ITEMS: 在此集合中添加你想在生成文件树和打包内容时 忽略的文件夹或文件名。

✍️ 作者

末伏之夜(notuhao)

星标情况