Getting Started

Up and running in 60 seconds

Step 1: Open a Markdown File

There are several ways to open a markdown file:

Step 2: Explore the Toolbar

The toolbar at the top of the window provides quick access to common actions:

Step 3: Customize (Optional)

Open Preferences (⌘,) to customize Markdown Lens:

General Tab

Extensions Tab

Document Health Tab

PDF Tab

Keyboard Shortcuts

Action Shortcut
Open File ⌘ O
Close Window ⌘ W
Find in Page ⌘ F
Find Next ⌘ G
Find Previous ⇧ ⌘ G
Zoom In ⌘ +
Zoom Out ⌘ -
Actual Size (100%) ⌘ 0
Export to PDF ⇧ ⌘ E
Export as Word Document ⌥ ⌘ E
Toggle Document Health ⇧ ⌘ D
Print ⌘ P
Preferences ⌘ ,

Live Reload

Markdown Lens automatically watches for changes to your file. When you save changes in your text editor, the preview updates instantly.

This works with any editor: VS Code, Vim, BBEdit, Sublime Text, TextEdit, or whatever you prefer.

Tips

Sample Files

Want to explore all the features? Download our sample files that showcase everything Markdown Lens can do:

The download includes:

These files use a fictional "Weather Dashboard" project theme to demonstrate realistic documentation scenarios.

Need More Help?

Check out our Support page for answers to common questions, or contact us directly.