Skip to Content

Usage

mdd                 # list Markdown files in the current directory to pick from
mdd README.md       # preview a file
mdd docs            # pick from the Markdown files in a folder
cat notes.md | mdd  # preview standard input

Preview a file

Run mdd FILE to open a file.

If a name has spaces, put quotes around it. If a name starts with -, write ./-name.md or mdd -- -name.md.

mddog opens only local files. To preview a file on the web, download it first:

curl -sL https://example.com/README.md | mdd

Pick a file

Run mdd with no file to pick from a file list of Markdown files in the current directory or Git repo. Use the arrow keys to select a file, then press Enter to open it.

Run mdd FOLDER to list the files in a specific folder instead.

Read standard input

When you pipe text into mdd, it previews that text as Markdown. For example:

cat notes.md | mdd
gh pr view 123 --json body -q .body | mdd

You can also run mdd - with nothing piped in, then type Markdown on the fly, and press Ctrl-D to preview it.

Options

FlagDescription
-h, --helpShow the help
-V, --versionShow the version
--Treat every argument after it as a file name

On this page