Skip to content

imadreamerboy/markitdown-gui

Repository files navigation

阅读中文版本

MarkItDown GUI Wrapper

A feature-rich GUI wrapper for MarkItDown, built with PySide6. Easily convert files to markdown using drag & drop.

Screenshot of the GUI

Features

  • 📂 File Management:

    • Drag & Drop for batch processing
    • File type filtering
    • Recent files history
    • Batch processing with pause/resume
  • 🎨 User Interface:

    • Dark/Light theme support
    • Preview panel
    • Progress tracking
    • Keyboard shortcuts
  • ⚙️ Advanced Options:

    • Format customization (headers, tables)
    • Auto-save and backup
    • Enable plugins
    • Document Intelligence API support
  • 🛠️ Output Options:

    • Save all in one file or separately
    • Choose output directory
    • Quick copy & paste
    • Preview before saving

Installation

You can download the precompiled executable from the Releases or build it from source. For that just follow the instructions below.

Prerequisites

  • Python 3.10+
  • Install dependencies:
pip install -r requirements.txt

Run the App

python -m markitdowngui.main

Keyboard Shortcuts

  • Ctrl+O: Open Files
  • Ctrl+S: Save Output
  • Ctrl+C: Copy Output
  • Ctrl+P: Pause/Resume
  • Ctrl+B: Begin Conversion
  • Ctrl+L: Clear List
  • Ctrl+K: Show Shortcuts
  • Esc: Cancel Conversion

Build a Standalone Executable

Use PyInstaller:

pyinstaller --clean --onefile --windowed -n MarkItDown markitdowngui/main.py

License

Licensed under MIT.

Note: PySide6 uses LGPLv3, requiring dynamic linking.

Contributing

Contributions welcome! Fork, open issues, or submit PRs.

Credits

About

Easily convert files to markdown using drag & drop.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages