Skip to content

Dhruv2mars/mdv

Repository files navigation

mdv

Terminal markdown visualizer/editor (Rust TUI).

Install

npm i -g @dhruv2mars/mdv

First run downloads the native mdv binary into ~/.mdv/bin/mdv. Binary artifacts are published on GitHub Releases per platform. Installer keeps verified cache under ~/.mdv/cache.

Supported release binaries:

  • darwin-arm64
  • darwin-x64
  • linux-arm64
  • linux-x64
  • win32-arm64
  • win32-x64

Use

mdv README.md

Manual upgrade:

mdv update

Uses detected install manager (bun/pnpm/yarn/npm), prefers original installer metadata.

Stream mode (stdin):

tail -f notes.md | mdv --stream

Keys

In-app docs: Cmd+,/Ctrl+, (Docs + Settings modal).

Quick ref:

  • Ctrl+Q quit
  • Ctrl+S save
  • Ctrl+R reload from disk
  • Shift+Tab (or Ctrl+T) switch editor/view mode
  • Ctrl+F search, Ctrl+H replace, Ctrl+G goto line
  • F3/Shift+F3 next/prev search result
  • Conflict flow: Ctrl+J/Ctrl+U hunk nav, Ctrl+E apply, Ctrl+K keep local, Ctrl+M merge

Flags

  • --readonly disable editing
  • --no-watch disable file watcher
  • --stream read markdown from stdin (no PATH arg)
  • --perf show perf info in status line
  • --theme <auto|default|high-contrast> set color theme
  • --no-color disable ANSI color
  • --focus <editor|view> initial focused pane

Installer Env

  • MDV_INSTALL_DEBUG=1 local installer debug logs
  • MDV_INSTALL_TIMEOUT_MS request timeout (default 15000)
  • MDV_INSTALL_RETRY_ATTEMPTS retries (default 3)

Dev/Contrib

See CONTRIBUTING.md.

About

markdown visualizer in rust

Resources

License

Contributing

Stars

Watchers

Forks

Contributors