A beautiful Markdown viewer for terminal with code execution support
Project description
MDX - Markdown Viewer for Terminal
A beautiful Markdown viewer for terminal with code execution support.
Features
- 🎨 Beautiful syntax highlighting with multiple themes
- 📑 Table of contents navigation
- ⚡ Execute code blocks directly (bash, python)
- 🔍 Search within documents
- 📖 Multiple rendering modes
Installation
pip install mdx
Usage
# View a markdown file
mdx README.md
# Show table of contents
mdx README.md --toc
# Execute code blocks
mdx README.md --execute
# Jump to specific line
mdx README.md --line 100
# Use different theme
mdx README.md --theme dracula
Options
| Option | Description |
|---|---|
-e, --execute |
Execute code blocks |
-t, --toc |
Show table of contents |
-l, --line |
Jump to specific line |
-m, --theme |
Syntax highlighting theme |
Themes
Available syntax highlighting themes:
- monokai (default)
- dracula
- github-dark
- nord
- solarized-dark
Example
# Read documentation
mdx docs/linux-0.11-filesystem-analysis.md --toc
# Execute tutorial code blocks
mdx docs/tutorial.md --execute
License
MIT License
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
mdx_viewer-0.1.0.tar.gz
(11.7 kB
view details)
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 mdx_viewer-0.1.0.tar.gz.
File metadata
- Download URL: mdx_viewer-0.1.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.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cfe244eb911d4a1f07784790ab51135012bee7192f81295b4d5ebdb893852ffb
|
|
| MD5 |
adf390018c8573955e853513e0af1c81
|
|
| BLAKE2b-256 |
53de5a0b605be7b82712e06caab48187fcc51ff793f470f2839536f3b375a36b
|
File details
Details for the file mdx_viewer-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mdx_viewer-0.1.0-py3-none-any.whl
- Upload date:
- Size: 12.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d9cd065cfa1927eb7bca9f50903df14686475fd828ff68a667a87d727ab2cd05
|
|
| MD5 |
ebc6796e2fb9a268f527e84ab3457b9c
|
|
| BLAKE2b-256 |
872cb9b2a05a6b1463d1593f0434b5c4809d58d397723c05cae2fef3fd2dc012
|
