Clean Markdown Reader

A lightweight, distraction-free markdown reader for VS Code. Finally, a proper way to read documentation.

Why Clean Markdown Reader?

VS Code's built-in markdown preview gets the job done for quick checks. But when you're settling in to read through project docs, a knowledge base, or technical specs? It falls short.

Clean Markdown Reader gives you a dedicated reading environment. You get a file tree, bookmarks, reading progress tracking, and a clean interface that stays out of your way. Think of it as "reader mode" for your markdown files.

Works great for:

• Project documentation and READMEs
• Knowledge bases and wikis
• Technical specifications
• Markdown-based note collections

Features

Two-Panel Layout

Your files live on the left, rendered content on the right. Drag the divider to adjust panel widths. Need to compare two documents? Split view lets you see them side-by-side (vertically or horizontally).

File Navigation

The extension scans your folder recursively and finds all markdown files automatically. Folders collapse and expand with a click. You can filter files using glob patterns like docs/**/*.md, and keyboard navigation works exactly as you'd expect—arrow keys to move, Enter to select.

Common clutter folders (node_modules, .git, dist, build) stay hidden by default. Quick folder switching through the activity bar keeps your recent folders within reach.

Reading Experience

Zoom from 50% to 200% using toolbar buttons or keyboard shortcuts. A progress bar shows how far you've scrolled, and reading time estimates help you plan your reading sessions. The auto-generated table of contents pulls from your document headings—click any entry to jump straight there.

Three theme modes give you control: Auto follows your VS Code theme, or force Light/Dark mode independently.

Organization

Star files to bookmark them for quick access later. The extension tracks your last 10 viewed files and 10 opened folders automatically. Panel widths, zoom levels, and bookmarks persist across sessions.

Markdown Rendering

Full CommonMark support covers headers, lists, tables, blockquotes, and code blocks. Syntax highlighting handles 180+ languages through highlight.js. Mermaid diagrams render inline with their own zoom and copy controls. YAML front-matter gets parsed and displayed cleanly, and relative image paths resolve correctly.

Code Blocks

Code blocks get syntax highlighting with auto-detection when you don't specify a language. Multi-line blocks show line numbers, and every block has a copy button for quick clipboard access.

Source Preview

Curious what the raw markdown looks like? Enable source preview and hover over any rendered element to see the original markup with line numbers.

Separate Window Mode

Prefer a dedicated window? Enable openInSeparateWindow in settings and the reader opens in its own VS Code instance.

Quick Start

1. Install from the VS Code Marketplace
2. Click the book icon in the Activity Bar
3. Select a folder with markdown files
4. Start reading—click any file in the tree

You can also click the book icon in the editor title bar when viewing a markdown file, right-click any .md file in Explorer and choose "Open in Clean Markdown Reader", right-click any folder and choose "Open with Clean Markdown Reader", or use the Command Palette.

Keyboard Shortcuts

On Mac, use Cmd instead of Ctrl

Settings

Find these under Settings → search "Clean Markdown Reader"

Custom CSS Example

/* Custom heading color */
.markdown-content h1 { color: #ff6b6b; }

/* Increase line height */
.markdown-content { line-height: 1.8; }

/* Custom code block style */
pre { border-radius: 8px; }

Context Menu

Right-click any file in the reader's file tree for quick actions:

Reader Actions:

• Open in Panel 1 / Panel 2
• Add/Remove Bookmark

VS Code Actions:

• Open in Editor
• Reveal in Explorer
• Open in Terminal

Copy Actions:

• Copy Path / Relative Path / File Name

File Management:

• Delete (with confirmation)

Supported File Types

.md · .markdown · .mdown · .mkd · .mkdn · .mdwn

Requirements

VS Code 1.108.0 or higher

Contributing

Found a bug? Have a feature request? Issues and pull requests are welcome at GitHub.

License

MIT

Clean Markdown Reader—read markdown the way it was meant to be read.