Usage

Read a file

Pass a Markdown file to render it in the terminal:

mdv README.md
mdv --theme nord --cols 100 README.md

Choose a preset when you want to reuse a set of options:

mdv --preset reader README.md

Read from a pipe

mdv reads standard input when used in a pipeline. A single dash selects standard input explicitly:

cat notes.md | mdv
mdv -

Browse a directory

Pass a directory, or use interactive mode for the current directory:

mdv docs/
mdv -i

Running mdv without arguments in a terminal also opens the browser. See Document browser for discovery rules.

Use a pager

mdv --pager README.md

The built-in pager adds search, copying, source-line navigation and editor integration. Learn the controls in Pager and editor.

Start at a section

mdv --from 'Installation' README.md
mdv --from 'Installation:20' README.md

--from begins at the first matching text. Adding :20 limits the selected source range to 20 lines. --reverse starts from the end while keeping block formatting intact.

mdv --no-config --theme catppuccin --cols 64 example.md

 First section
  
  First paragraph.
  
  Second paragraph.

 Next section
  
  Keep reading.

## First section

First paragraph.

Second paragraph.

## Next section

Keep reading.

Parameter reference

The complete CLI reference describes every option. Use layout, code blocks, callouts, lists and links for formats and examples. Configuration explains how to save the same settings in YAML.