markdown-reader
Lightweight, fast Markdown viewer for Linux, macOS & Windows.
Built on Qt5. Blazing-fast, minimal RAM, zero bloat.
Install
# Install
pipx install markdown-reader
# Execute
markdown-reader /path/to/file.md
Or:
# 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
markdown-reader # Open viewer
markdown-reader file.md # Open file directly
Zoom:
Ctrl++: Zoom inCtrl+-: Zoom outCtrl+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
Philosophy: Keep it simple. One tool, one job, done well.
1 maintainer
Release files for markdown-reader 0.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| markdown_reader-0.2.3.tar.gz | 16.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| markdown_reader-0.2.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 33.8 kB
Release files / markdown_reader-0.2.3.tar.gz
| Download URL | markdown_reader-0.2.3.tar.gz |
|---|---|
| Size | 16.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ae852d1c6a57508e6ee925e0631c1aca49cd94da13e2b0ef1bcdeaf83f63af99
|
|
BLAKE2b-256 checksum How to use checksums |
62e54c87026ffea435cd7b3f20a11fd0a2150595bc84c05c47ee241d4a74dec0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
Release files / markdown_reader-0.2.3-py3-none-any.whl
| Download URL | markdown_reader-0.2.3-py3-none-any.whl |
|---|---|
| Size | 17.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4545c1aa6a870ed86e993d7b0041ddfe826aef7cfa21ba6c5f2f3c7ffe431bf9
|
|
BLAKE2b-256 checksum How to use checksums |
00a218c8e6aaa3b50469daa87f012983c543b73d169e12bf78eccfc51484c898
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
