INDEX.md
Documentation Index
Welcome to the Ultimate Media Downloader documentation. This index helps you find the information you need.
Quick Links
| I want to... | Go to... |
|---|---|
| Install the application | Installation Guide |
| Learn how to use it | Usage Guide |
| Download 4K wallpapers | Downloading Wallpapers |
| Update to latest version | Auto-Update Guide |
| Understand how it works | Architecture |
| Configure settings | Configuration Guide |
| Fix a problem | Troubleshooting |
Documentation Map
Loading diagram...
Available Documents
For Users
| Document | Description |
|---|---|
| Installation Guide | How to install on any operating system |
| Usage Guide | Complete guide to using the application |
| Configuration Guide | All configuration options explained |
| Auto-Update Guide | Automatic version checking and updates |
| Troubleshooting | Solutions to common problems |
| Changelog | Version history and release notes |
For Developers
| Document | Description |
|---|---|
| Architecture | System design with diagrams |
| Handlers Documentation | Platform handler details |
| File Structure | Project organization |
| Project Overview | High-level project summary |
Reading Order for New Users
- Installation Guide - Get the application running
- Usage Guide - Learn basic commands
- Configuration Guide - Customize settings (optional)
Reading Order for Developers
- Project Overview - Understand the project
- Architecture - Learn the design
- File Structure - Navigate the code
- Handlers Documentation - Extend functionality
Quick Reference
Basic Commands
# Start interactive mode
umd
# Download video
umd "URL"
# Download audio
umd "URL" --audio-only --format mp3
# Browse 4K wallpapers
umd --wallpaper
# Search wallpapers
umd --wallpaper-search "anime"
# Show help
umd --help
Common Options
| Option | Description |
|---|---|
--audio-only | Extract audio only |
--format mp3 | Set output format |
--quality 1080p | Set video quality |
--output DIR | Set download directory |
--verbose | Show detailed output |
--wallpaper | Browse & download 4K wallpapers |
--wallpaper-search QUERY | Search 4kwallpapers.com directly |
Getting Help
If you cannot find what you need:
- Check the Troubleshooting Guide
- Search the documentation for keywords
- Run
umd --helpfor command reference - Create an issue on Codeberg
Contributing to Documentation
Documentation improvements are welcome. When contributing:
- Use clear, simple language
- Include examples where helpful
- Add Mermaid diagrams for complex concepts
- Keep formatting consistent