Skip to content

mw2000/melo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

melo logo

🌿 melo

A mellow terminal markdown viewer. Read .md files comfortably in your terminal.

Installation

curl -fsSL https://raw.githubusercontent.com/mw2000/melo/main/install.sh | sh

This downloads the latest release binary to ~/.local/bin. Make sure it's on your PATH:

export PATH="$HOME/.local/bin:$PATH"

From source

just install

Or with cargo directly: cargo install --path . (requires Rust 1.85+).

Usage

melo <file>

Pipe from stdin:

cat README.md | melo
curl -s https://example.com/doc.md | melo

Pass --help or --version for the usual.

Themes

Choose a color theme with --theme:

melo --theme ocean README.md

Available themes: dark (default), light, ocean.

Configuration

Create ~/.config/melo/config.toml to set defaults:

theme = "ocean"

CLI flags override config file values.

Keybindings

Key Action
j / Scroll down
k / Scroll up
Ctrl-d / PageDown Half-page down
Ctrl-u / PageUp Half-page up
g / Home Jump to top
G / End Jump to bottom
Tab / Shift-Tab Next / previous heading
t Table of contents
o Open link picker
Backspace Go back (after following a link)
/ Search
n / N Next / previous match
? Toggle help overlay
q / Esc Quit

Mouse scroll is supported.

Features

  • Syntax-highlighted code blocks with GitHub-style borders
  • Tables with box-drawing characters
  • Heading styles (H1 with background, H2-H6 bold + color)
  • Inline formatting (bold, italic, strikethrough, inline code)
  • Table of contents popup with heading navigation
  • Link picker with browser opening
  • Relative markdown link following with back navigation
  • YAML front matter stripping
  • Inline image rendering (PNG, JPEG, GIF) via halfblock encoding
  • File watching with auto-reload
  • Three built-in color themes
  • Configurable via TOML config file

Built With

License

MIT

About

A mellow terminal markdown viewer

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors