# nb2md

**Repository Path**: kill-life/nb2md

## Basic Information

- **Project Name**: nb2md
- **Description**: ipynb转md工具
- **Primary Language**: Python
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-04
- **Last Updated**: 2025-11-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Jupyter Notebook 转 Markdown 工具

一个现代化、高性能的可视化工具，用于批量将 Jupyter Notebook (.ipynb) 文件转换为 Markdown (.md) 格式。采用 PyQt5 构建，支持并发处理，大幅提高批量转换效率。

## 功能特点

1. **高性能并发处理**：使用线程池并行转换多个文件，显著提升批量处理速度
2. **现代化界面**：采用 PyQt5 构建的优雅图形界面，支持图标、颜色标识和响应式布局
3. **批量文件转换**：支持选择多个.ipynb文件或整个文件夹进行批量转换
4. **同目录保存**：转换后的.md文件默认保存在原文件相同目录下
5. **详细进度反馈**：实时显示转换进度、状态和详细日志信息
6. **直观的状态标识**：使用不同颜色标识文件转换状态（成功/失败）
7. **可中断操作**：支持在转换过程中随时停止操作
8. **Windows平台优化**：针对Windows系统优化，确保中文显示正常

## 系统要求

- Windows 操作系统
- Python 3.7 或更高版本
- 已安装 Jupyter Notebook 和 nbconvert 组件（可通过 `pip install jupyter` 安装，这会自动包含 nbconvert）
- PyQt5 库（可通过 `pip install PyQt5` 安装）

## 使用方法

1. 确保已安装 Jupyter Notebook 和 nbconvert（本工具的核心转换功能依赖于 jupyter nbconvert）：
   ```
   pip install jupyter
   ```
   
   或者直接安装项目所需的所有依赖：
   ```
   pip install -r requirements.txt
   ```

2. 运行程序：
   ```
   python nb2md_converter.py
   ```

3. 使用界面功能：
   - **添加文件**：选择一个或多个.ipynb文件
   - **添加文件夹**：选择包含.ipynb文件的文件夹（会自动查找所有.ipynb文件）
   - **移除选中文件**：移除当前选中的文件
   - **清空列表**：清空所有文件
   - **开始转换**：批量转换所有添加的文件

## 转换过程

- 转换后的Markdown文件将保存在与原.ipynb文件相同的目录中
- 转换进度和日志将实时显示在界面中
- 成功/失败的状态会显示在文件列表中

## 故障排除

如果遇到"未找到jupyter命令"或"未找到nbconvert"的错误，请确保：
1. Jupyter Notebook 和 nbconvert 已正确安装
2. Python和pip的路径已添加到系统环境变量中

可以通过以下命令验证Jupyter和nbconvert安装：
```
jupyter --version
jupyter nbconvert --version
```

## 开发信息

- 作者：Auto-Generated
- 版本：1.0
- 许可证：MIT