Metadata-Version: 2.4
Name: markdown-reader
Version: 0.2.3
Summary: Lightweight easy to use Markdown Viewer for Linux, macOS & Windows. Built on Qt5. Blazing-fast, minimal RAM, zero bloat. File navigation, Image caching. GPL v3 open-source
Author: kaibruell
Project-URL: Homepage, https://github.com/kaibruell/markdown-reader
Project-URL: Documentation, https://github.com/kaibruell/markdown-reader
Project-URL: Repository, https://github.com/kaibruell/markdown-reader.git
Project-URL: Issues, https://github.com/kaibruell/markdown-reader/issues
Keywords: python,windows,macos,linux,markdown,cli,lightweight,open-source,documentation,gui,arch-linux,qt5,easy-to-use,markdown-viewer,maintainable,styleable,markdown-reader,cross-platform,highly-customizable
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: X11 Applications :: Qt
Classifier: Intended Audience :: End Users/Desktop
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business
Classifier: Topic :: Text Editors
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyQt5>=5.15.0
Requires-Dist: mistune>=3.0.0
Requires-Dist: Pillow>=9.0.0
Requires-Dist: darkdetect>=0.8.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: black>=22.0; extra == "dev"
Requires-Dist: flake8>=4.0; extra == "dev"
Requires-Dist: isort>=5.0; extra == "dev"
Requires-Dist: tomli>=1.0.0; python_version < "3.11" and extra == "dev"
Dynamic: license-file

# markdown-reader

**Lightweight, fast Markdown viewer** for Linux, macOS & Windows.

Built on Qt5. Blazing-fast, minimal RAM, zero bloat.

## Install

```bash
# Install
pipx install markdown-reader

# Execute
markdown-reader /path/to/file.md
```

Or:

```bash
# Install
pip install markdown-reader

# Execute
markdown-reader /path/to/file.md
```

## Features

- Renders Markdown beautifully with mistune
- Fast start, minimal RAM (optimized for older hardware)
- File tree navigation
- Image auto-caching and scaling
- Zoom (50% - 300%)
- Cross-platform (Linux, macOS, Windows)
- No bloat

## Why I built it?

Existing Markdown viewers were too heavy:
- Electron: 150+ MB, 500+ MB RAM
- WebKit/Chromium: Massive overhead
- Qt WebEngine: Still Chromium

**QTextBrowser** is the answer. Lightweight HTML renderer, designed for documentation. Perfect for Markdown.

## Usage

```bash
markdown-reader                    # Open viewer
markdown-reader file.md            # Open file directly
```

**Zoom:**
- `Ctrl` + `+` : Zoom in
- `Ctrl` + `-` : Zoom out
- `Ctrl` + `0` : Reset

## Requirements

- Python >= 3.8
- PyQt5 >= 5.15.0
- mistune >= 3.0.0
- Pillow >= 9.0.0

## License

GNU General Public License v3.0 – see [LICENSE](LICENSE)

---

**Philosophy:** *Keep it simple. One tool, one job, done well.*
