Skip to content
axtesysPublic

About

A fast, lightweight terminal markdown pager built in Rust. Features syntax highlighting, full-text search, interactive keyboard navigation, table rendering, and text wrapping. Designed for speed, safety, and beautiful terminal output.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

mdless-rs

A terminal markdown pager with syntax highlighting, written in Rust.

AI Disclosure

This project was built entirely with AI assistance. All code, documentation, tests, security audits, and code reviews were generated using AI tools. Human oversight was applied throughout.

Features

  • Syntax-highlighted code blocks (via syntect)
  • Search with match highlighting
  • Word wrap with proper Unicode support
  • Tables with box-drawing borders
  • Blockquote rendering with gutters
  • Footnote support
  • Task list checkboxes
  • Link URLs displayed inline
  • NO_COLOR environment variable support

Installation

Build from source:

cargo build --release
cp target/release/mdless-rs /usr/local/bin/

Or using Docker (outputs to dist/mdless-rs):

make build

Usage

mdless-rs <file.md>
cat file.md | mdless-rs

Key Bindings

Key Action
j / Down / Enter Scroll down one line
k / Up Scroll up one line
d / Ctrl+D Half page down
u / Ctrl+U Half page up
f / Space / PgDn Page down
b / PgUp Page up
g / Home Go to top
G / End Go to bottom
/ Start search
n Next match
N Previous match
Esc Cancel search
h Toggle help
q Quit

Environment Variables

  • NO_COLOR - When set, disables all color output.
  • COLUMNS - Used as terminal width when output is piped.

Security

See SECURITY_AUDIT.md for a full security audit report.

License

MIT - see LICENSE.

About

A fast, lightweight terminal markdown pager built in Rust. Features syntax highlighting, full-text search, interactive keyboard navigation, table rendering, and text wrapping. Designed for speed, safety, and beautiful terminal output.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages