Skip to content

Commit 9c4ee0c

Browse files
committed
Refresh EN/ZH README for Fluent UI refactor and new screenshot
1 parent eba96e4 commit 9c4ee0c

File tree

4 files changed

+118
-136
lines changed

4 files changed

+118
-136
lines changed

README.md

Lines changed: 59 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -2,119 +2,105 @@
22

33
# MarkItDown GUI Wrapper
44

5-
A feature-rich **GUI wrapper** for `MarkItDown`, built with **PySide6**. Easily convert files to markdown using drag & drop.
5+
A desktop GUI for `MarkItDown`, built with `PySide6` and `QFluentWidgets`.
6+
It focuses on fast multi-file conversion to Markdown with a modern Fluent-style interface.
67

8+
![Current UI screenshot](image.png)
79

8-
![Screenshot of the GUI](gui.png)
10+
## Current Status
11+
12+
- Main conversion workflow is stable and production-usable.
13+
- The UI refactor to `QFluentWidgets` is active and already shipped for the main screens (`Home`, `Settings`, `Help`).
14+
- Current polish work is focused on visual consistency (Solarized light + Nord dark themes), typography, and startup-time improvements for packaged builds.
915

1016
## Features
1117

12-
- 📂 **File Management**:
13-
- Drag & Drop for batch processing
14-
- File type filtering
15-
- Recent files history
16-
- Batch processing with pause/resume
17-
18-
- 🎨 **User Interface**:
19-
- Dark/Light theme support
20-
- Preview panel
21-
- Progress tracking
22-
- Keyboard shortcuts
23-
24-
- ⚙️ **Advanced Options**:
25-
- Format customization (headers, tables)
26-
- Auto-save and backup
27-
- Enable plugins
28-
- Document Intelligence API support
29-
30-
- 🛠️ **Output Options**:
31-
- Save all in one file or separately
32-
- Choose output directory
33-
- Quick copy & paste
34-
- Preview before saving
18+
- Queue-based file workflow with drag and drop.
19+
- Batch conversion with start, pause/resume, cancel, and progress feedback.
20+
- Results view with per-file selection and Markdown preview.
21+
- Preview modes: rendered Markdown view and raw Markdown view.
22+
- Save modes: export as one combined file or separate files.
23+
- Quick actions: copy Markdown, save output, back to queue, start over.
24+
- Settings for output folder, batch size, header style, table style, and theme mode (light/dark/system).
25+
- Built-in shortcuts dialog, update check action, and about dialog.
3526

3627
## Installation
3728

38-
You can download the precompiled executable from the [Releases](https://github.com/imadreamerboy/markitdown-gui/releases) or build it from source. For that just follow the instructions below.
29+
Download prebuilt binaries from [Releases](https://github.com/imadreamerboy/markitdown-gui/releases), or run from source.
3930

4031
### Prerequisites
4132

42-
- Python **3.10+**
43-
- create a venv
44-
- Install dependencies (preferred via `uv`):
33+
- Python `3.10+`
34+
- `uv` (recommended)
35+
36+
Install dependencies:
4537

4638
```sh
47-
uv sync
39+
uv sync
4840
```
49-
or
41+
42+
Alternative:
5043

5144
```sh
52-
pip install -r requirements.txt
45+
pip install -e .[dev]
5346
```
5447

55-
### Run the App
48+
## Run the App
5649

5750
```sh
5851
uv run python -m markitdowngui.main
5952
```
6053

61-
### Keyboard Shortcuts
54+
## Keyboard Shortcuts
6255

63-
- `Ctrl+O`: Open Files
64-
- `Ctrl+S`: Save Output
65-
- `Ctrl+C`: Copy Output
66-
- `Ctrl+P`: Pause/Resume
67-
- `Ctrl+B`: Begin Conversion
68-
- `Ctrl+L`: Clear List
69-
- `Ctrl+K`: Show Shortcuts
70-
- `Esc`: Cancel Conversion
56+
- `Ctrl+O`: Open files
57+
- `Ctrl+S`: Save output
58+
- `Ctrl+C`: Copy output
59+
- `Ctrl+P`: Pause/resume
60+
- `Ctrl+B`: Start conversion
61+
- `Ctrl+L`: Clear queue
62+
- `Ctrl+K`: Show shortcuts
63+
- `Esc`: Cancel conversion
7164

7265
## Build a Standalone Executable
7366

74-
First activate the development environment:
75-
7667
```sh
7768
uv pip install -e .[dev]
69+
pyinstaller MarkItDown.spec --clean --noconfirm
7870
```
7971

80-
Use `PyInstaller`:
81-
82-
```sh
83-
pyinstaller MarkItDown.spec --clean
84-
```
85-
86-
The default spec builds an `onedir` bundle at `dist/MarkItDown/` for faster startup.
72+
The default spec builds an `onedir` app in `dist/MarkItDown/`.
73+
Release workflows package this folder into platform-specific `.zip` artifacts.
8774

8875
## License
8976

90-
Licensed under **GPLv3 for non-commercial projects**.
77+
Licensed under **GPLv3 for non-commercial use**.
9178

92-
Commercial use requires a separate commercial license.
93-
This aligns with the licensing model stated by `PySide6-Fluent-Widgets` (`qfluentwidgets`).
79+
Commercial use requires a separate commercial license.
80+
This follows the non-commercial licensing requirements of `PySide6-Fluent-Widgets` (`qfluentwidgets`).
9481

9582
## Contributing
9683

97-
Contributions are welcome! Please follow these steps to contribute:
98-
99-
1. **Fork the repository** and create a new branch for your feature or bug fix.
100-
2. **Set up the development environment**:
101-
- It is recommended to use a virtual environment.
102-
- This project uses `uv` for package management.
103-
- To install all dependencies, including for development and testing, run:
104-
```sh
105-
uv pip install -e .[dev]
106-
```
107-
3. **Make your changes**.
108-
4. **Run the tests** to ensure everything is working correctly:
109-
```sh
110-
pytest
111-
```
112-
5. **Submit a pull request** with a clear description of your changes.
84+
1. Fork the repository and create a branch.
85+
2. Install dev dependencies:
86+
87+
```sh
88+
uv pip install -e .[dev]
89+
```
90+
91+
3. Make your changes.
92+
4. Run tests:
93+
94+
```sh
95+
uv run pytest -q
96+
```
97+
98+
5. Open a pull request with a clear summary.
11399

114100
## Credits
115101

116-
- **MarkItDown** ([MIT License](https://opensource.org/licenses/MIT))
117-
- **PySide6** ([LGPLv3 License](https://www.gnu.org/licenses/lgpl-3.0.html))
118-
- **Lucide Icons** ([MIT License](https://lucide.dev/))
102+
- MarkItDown ([MIT License](https://opensource.org/licenses/MIT))
103+
- PySide6 ([LGPLv3 License](https://www.gnu.org/licenses/lgpl-3.0.html))
104+
- PySide6-Fluent-Widgets / QFluentWidgets ([Project site](https://qfluentwidgets.com))
119105

120106

README_zh.md

Lines changed: 59 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,102 @@
11
# MarkItDown GUI 封装
22

3-
一个功能丰富的 **GUI 封装**,用于 `MarkItDown`,使用 **PySide6** 构建。通过拖放轻松将文件转换为 markdown。
4-
5-
![截图](gui.png)
6-
## 特性
7-
8-
- 📂 **文件管理**:
9-
- 拖放以进行批量处理
10-
- 文件类型过滤
11-
- 最近文件历史记录
12-
- 批量处理,支持暂停/恢复
13-
14-
- 🎨 **用户界面**:
15-
- 深色/浅色主题支持
16-
- 预览面板
17-
- 进度跟踪
18-
- 键盘快捷键
19-
20-
- ⚙️ **高级选项**:
21-
- 格式自定义(标题、表格)
22-
- 自动保存和备份
23-
- 启用插件
24-
- 文档智能 API 支持
25-
26-
- 🛠️ **输出选项**:
27-
- 全部保存在一个文件中或单独保存
28-
- 选择输出目录
29-
- 快速复制和粘贴
30-
- 保存前预览
3+
这是一个基于 `PySide6``QFluentWidgets``MarkItDown` 桌面 GUI。
4+
目标是用更直观的界面完成多文件到 Markdown 的转换。
5+
6+
![当前界面截图](image.png)
7+
8+
## 当前开发状态
9+
10+
- 核心转换流程已经稳定,可正常日常使用。
11+
- `QFluentWidgets` 重构已覆盖主要页面(`Home``Settings``Help`)。
12+
- 当前优化重点是视觉一致性(Solarized 浅色 + Nord 深色)、排版细节,以及打包版本的启动速度。
13+
14+
## 功能
15+
16+
- 基于队列的文件流程,支持拖放添加文件。
17+
- 批量转换,支持开始、暂停/恢复、取消和进度反馈。
18+
- 结果页支持按文件查看转换结果。
19+
- 预览模式支持渲染视图和原始 Markdown 视图。
20+
- 保存模式支持合并为单文件或分别保存多个文件。
21+
- 常用操作:复制 Markdown、保存输出、返回队列、重新开始。
22+
- 设置项包括输出目录、批处理大小、标题样式、表格样式、主题模式(浅色/深色/跟随系统)。
23+
- 内置快捷键面板、检查更新入口和关于对话框。
3124

3225
## 安装
3326

34-
您可以从 [Releases](https://github.com/imadreamerboy/markitdown-gui/releases) 下载预编译的可执行文件,或从源代码构建。为此,只需按照以下说明操作
27+
你可以从 [Releases](https://github.com/imadreamerboy/markitdown-gui/releases) 下载预编译版本,或从源码运行
3528

36-
### 先决条件
29+
### 前置要求
3730

38-
- Python **3.10+**
39-
- 安装依赖项:
31+
- Python `3.10+`
32+
- 推荐使用 `uv`
33+
34+
安装依赖:
4035

4136
```sh
4237
uv sync
4338
```
4439

45-
40+
也可以:
4641

4742
```sh
48-
pip install -r requirements.txt
43+
pip install -e .[dev]
4944
```
5045

51-
### 运行应用程序
46+
## 运行应用
5247

5348
```sh
54-
uv python -m markitdowngui.main
49+
uv run python -m markitdowngui.main
5550
```
5651

57-
### 键盘快捷键
52+
## 键盘快捷键
5853

5954
- `Ctrl+O`: 打开文件
6055
- `Ctrl+S`: 保存输出
6156
- `Ctrl+C`: 复制输出
6257
- `Ctrl+P`: 暂停/恢复
6358
- `Ctrl+B`: 开始转换
64-
- `Ctrl+L`: 清空列表
59+
- `Ctrl+L`: 清空队列
6560
- `Ctrl+K`: 显示快捷键
6661
- `Esc`: 取消转换
6762

6863
## 构建独立可执行文件
6964

70-
使用 `PyInstaller`
71-
7265
```sh
73-
pyinstaller MarkItDown.spec --clean
74-
66+
uv pip install -e .[dev]
67+
pyinstaller MarkItDown.spec --clean --noconfirm
7568
```
7669

70+
默认会生成 `onedir` 结构,输出目录为 `dist/MarkItDown/`
71+
发布工作流会将该目录打包为按平台区分的 `.zip` 制品。
72+
7773
## 许可证
7874

79-
根据 **MIT** 许可证授权
75+
本项目采用 **GPLv3(仅限非商业用途)**
8076

81-
**注意:** `PySide6` 使用 **LGPLv3**,需要动态链接。
77+
商业用途需要单独的商业授权。
78+
该策略与 `PySide6-Fluent-Widgets``qfluentwidgets`)的非商业许可要求保持一致。
8279

8380
## 贡献
8481

85-
欢迎贡献!请按照以下步骤进行贡献:
86-
87-
1. **Fork 本仓库**并为您的功能或错误修复创建一个新分支。
88-
2. **设置开发环境**
89-
* 建议使用虚拟环境。
90-
* 本项目使用 `uv` 进行包管理。
91-
* 要安装所有依赖项(包括开发和测试依赖项),请运行:
92-
```sh
93-
uv pip install -e .[dev]
94-
```
95-
3. **进行更改**
96-
4. **运行测试**以确保一切正常:
97-
```sh
98-
pytest
99-
```
100-
5. **提交拉取请求**并清楚地描述您的更改。
82+
1. Fork 仓库并创建分支。
83+
2. 安装开发依赖:
84+
85+
```sh
86+
uv pip install -e .[dev]
87+
```
88+
89+
3. 提交代码修改。
90+
4. 运行测试:
91+
92+
```sh
93+
uv run pytest -q
94+
```
95+
96+
5. 提交 PR,并清楚说明变更内容。
10197

10298
## 鸣谢
10399

104-
- **MarkItDown** ([MIT 许可证](https://opensource.org/licenses/MIT))
105-
- **PySide6** ([LGPLv3 许可证](https://www.gnu.org/licenses/lgpl-3.0.html))
106-
- **Lucide Icons** ([MIT 许可证](https://lucide.dev/))
100+
- MarkItDown ([MIT 许可证](https://opensource.org/licenses/MIT))
101+
- PySide6 ([LGPLv3 许可证](https://www.gnu.org/licenses/lgpl-3.0.html))
102+
- PySide6-Fluent-Widgets / QFluentWidgets ([项目主页](https://qfluentwidgets.com))

gui.png

-36.3 KB
Binary file not shown.

image.png

29.9 KB
Loading

0 commit comments

Comments
 (0)