# 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.*
Raw data
{
"_id": null,
"home_page": null,
"name": "markdown-reader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"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",
"author": "kaibruell",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e7/67/721b3d85101bad22569c084d66fb626f191f16036b1a32e9496e9bc84bf3/markdown_reader-0.2.0.tar.gz",
"platform": null,
"description": "# markdown-reader\n\n**Lightweight, fast Markdown viewer** for Linux, macOS & Windows.\n\nBuilt on Qt5. Blazing-fast, minimal RAM, zero bloat.\n\n## Install\n\n```bash\n# Install\npipx install markdown-reader\n\n# Execute\nmarkdown-reader /path/to/file.md\n```\n\nOr:\n\n```bash\n# Install\npip install markdown-reader\n\n# Execute\nmarkdown-reader /path/to/file.md\n```\n\n## Features\n\n- Renders Markdown beautifully with mistune\n- Fast start, minimal RAM (optimized for older hardware)\n- File tree navigation\n- Image auto-caching and scaling\n- Zoom (50% - 300%)\n- Cross-platform (Linux, macOS, Windows)\n- No bloat\n\n## Why I built it?\n\nExisting Markdown viewers were too heavy:\n- Electron: 150+ MB, 500+ MB RAM\n- WebKit/Chromium: Massive overhead\n- Qt WebEngine: Still Chromium\n\n**QTextBrowser** is the answer. Lightweight HTML renderer, designed for documentation. Perfect for Markdown.\n\n## Usage\n\n```bash\nmarkdown-reader # Open viewer\nmarkdown-reader file.md # Open file directly\n```\n\n**Zoom:**\n- `Ctrl` + `+` : Zoom in\n- `Ctrl` + `-` : Zoom out\n- `Ctrl` + `0` : Reset\n\n## Requirements\n\n- Python >= 3.8\n- PyQt5 >= 5.15.0\n- mistune >= 3.0.0\n- Pillow >= 9.0.0\n\n## License\n\nGNU General Public License v3.0 \u2013 see [LICENSE](LICENSE)\n\n---\n\n**Philosophy:** *Keep it simple. One tool, one job, done well.*\n",
"bugtrack_url": null,
"license": null,
"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",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/kaibruell/markdown-reader",
"Homepage": "https://github.com/kaibruell/markdown-reader",
"Issues": "https://github.com/kaibruell/markdown-reader/issues",
"Repository": "https://github.com/kaibruell/markdown-reader.git"
},
"split_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"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e35f9a765b30b1e4958c210c62610e5a9b8ca2b79bf426d94f4c0d1b8110fc07",
"md5": "5844739b094baaf6f966caeb485d5440",
"sha256": "7e16833a967f4b199d58aea1986a3a555dfb0eabd52028d73034de083d677073"
},
"downloads": -1,
"filename": "markdown_reader-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5844739b094baaf6f966caeb485d5440",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14551,
"upload_time": "2025-11-01T20:27:38",
"upload_time_iso_8601": "2025-11-01T20:27:38.875604Z",
"url": "https://files.pythonhosted.org/packages/e3/5f/9a765b30b1e4958c210c62610e5a9b8ca2b79bf426d94f4c0d1b8110fc07/markdown_reader-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e767721b3d85101bad22569c084d66fb626f191f16036b1a32e9496e9bc84bf3",
"md5": "7efcf4123c5ee35e8cfcbecf3e4fdabc",
"sha256": "eaf3ee8920124db1cd715ea37c1bdf94b28f118ce0ec0214a623637b982fafa0"
},
"downloads": -1,
"filename": "markdown_reader-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "7efcf4123c5ee35e8cfcbecf3e4fdabc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14050,
"upload_time": "2025-11-01T20:27:40",
"upload_time_iso_8601": "2025-11-01T20:27:40.066254Z",
"url": "https://files.pythonhosted.org/packages/e7/67/721b3d85101bad22569c084d66fb626f191f16036b1a32e9496e9bc84bf3/markdown_reader-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-01 20:27:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kaibruell",
"github_project": "markdown-reader",
"github_not_found": true,
"lcname": "markdown-reader"
}
JSON
