A professional Markdown to HTML converter and viewer
Project description
mdview-py
A professional command-line utility to convert Markdown files to standalone HTML files and display them in a local webview window or your favorite browser.
Features
- Fast Parsing: Powered by
mistune3.x. - Extended Syntax:
- Emojis (e.g.,
:rocket:,:)) - MathJax compatibility (Inline
$...$and Block$$...$$) - Underlining (
++text++) - Strikethrough, Task lists, Tables, Footnotes, etc.
- Emojis (e.g.,
- Syntax Highlighting: Beautiful code blocks via
Pygments. - Multiple Themes: GitHub Light, GitHub Dark, and Paper themes.
- Flexible Viewing:
- Built-in
pywebviewdesktop window. - "App Mode" in your default browser.
- Built-in
- Portable Design: Modular Python package structure.
Installation
pip install mdview-py
Note: For testing purposes, you can install the latest beta from TestPyPI using:
pip install --index-url https://test.pypi.org/simple/ mdview-py
Usage
# Basic usage (opens in webview)
mdview document.md
# Use a specific theme
mdview document.md --theme github_dark
# Open in default browser (app mode)
mdview document.md --browser
# Generate HTML only (no viewer)
mdview document.md --no-view -o output.html
Build Executable (Windows)
Run makexe.bat to generate a standalone .exe using PyInstaller.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mdview_py-0.2.0.tar.gz.
File metadata
- Download URL: mdview_py-0.2.0.tar.gz
- Upload date:
- Size: 11.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e1b21b15b758ee03016409a2d6b0c5e1908ffdf69ee3e1c8c43623632ce55e04
|
|
| MD5 |
cbe75e3c7ebc18a44fcb54ac134c93fa
|
|
| BLAKE2b-256 |
558043a9172f6a885eefd899804f793ea469819d6c61003bb3b3c70724e7e14b
|
File details
Details for the file mdview_py-0.2.0-py3-none-any.whl.
File metadata
- Download URL: mdview_py-0.2.0-py3-none-any.whl
- Upload date:
- Size: 12.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ad5d3c4b02ca522e11de28e85a4e2be65fbb409ded4d6d5e8122cab514a58eb3
|
|
| MD5 |
cb5725e46a72564037be2f695b4423ea
|
|
| BLAKE2b-256 |
751df83d0761751422246bf2ad278ead7eb7044f836061ce974c1917324f584c
|