Skip to content

the-long-ride/markdown-explorer

Repository files navigation

Markdown Explorer

License: MIT VS Code Marketplace Open VSX Latest Release

Markdown files are built for AI agents. Markdown Explorer makes them pleasant for humans.

It turns .md and .mdx folders into a private, searchable documentation app with workspace navigation, rendered diagrams, math, videos, highlighted code, interactive tables, charts, tabs, and desktop support for Windows, Linux, and macOS.

Homepage: https://the-long-ride.github.io/markdown-explorer/

Markdown Explorer homepage with workspace navigation and reading layout

Why It Feels Different

  • Read workspaces, not loose files: file tree, table of contents, section cards, copy buttons, recent workspaces, and desktop tabs.
  • Preview more document types: opt in to local conversion for DOCX, PDF, HTML, XLSX, PPTX, ODT, ODP, ODS, RTF, and TXT files, with an in-app note that converted previews may lose layout or formatting quality.
  • Search where you need: current file, current workspace, or every open desktop tab, with content excerpts and exact jump-to-result behavior.
  • Stay keyboard-first: use Sidebar Cursor mode to move through folders and files with Alt+S, arrow keys, Enter, and Esc.
  • Shape the workspace: file tabs, Scope Focus, Theme Remix, and settings import/export keep large doc sets personal without changing project files.
  • Render rich Markdown: Mermaid, LaTeX math, images, streaming video, MDX, HTML sandboxes, callouts, frontmatter, and code blocks.
  • Use data inside docs: sort, filter, multi-select table filters, collapse large tables, and switch tables into Bar, Line, or Pie charts.
  • Stay private: rendering and indexing are local. No telemetry, no file uploads.

Install

Platform Get It
VS Code Install from VS Code Marketplace
Open VSX Install from Open VSX
Windows desktop Download the latest .exe
Linux desktop Download .AppImage or .deb
macOS desktop Download .dmg for arm64 or x64. First launch notes: macOS guide

Recent Feature Guide

Recent releases from v1.4.5 onward focus on faster navigation, safer desktop workflow, and richer local previews.

Converted DOCX preview with best-effort quality notice Sidebar Cursor mode highlighting the file tree Theme Remix settings for custom Markdown Explorer themes

  • Workspace links: links that start with /, ./, or ../ navigate to files inside the current workspace and stay in back/forward history.
  • Reading polish: table Wrap/Unwrap controls, code gutter selection highlighting, compact Markdown chrome, and clearer string interpolation make dense docs easier to scan.
  • Desktop recovery: workspace switching is confirmed, unavailable workspaces show recovery actions, and stale recent entries can be removed.
  • Theme Remix: create, duplicate, edit, import, and export custom themes with color, density, spacing, and optional background image controls.
  • Content File Tabs and Scope Focus: keep opened docs in tabs, narrow the sidebar to selected files/folders for the current workspace, and automatically keep scoped files aligned when the workspace changes.
  • Converted document previews: enable best-effort local previews for DOCX, PDF, HTML, XLSX, PPTX, ODT, ODP, ODS, RTF, and TXT.
  • Sidebar Cursor mode: press Alt+S, move with Up/Down, press Enter to expand folders or open files, and press Esc or click outside the sidebar to exit.

Search Modes

Find the exact content you need, then jump to the exact clicked match.

Find inside the currently opened Markdown file Search current workspace content Search across all desktop workspace tabs

Tables That Stay Useful

Markdown tables become real data views: search rows, sort columns, multi-select filter values, keep large datasets collapsed, and switch to charts when numeric data is detected.

Markdown table rendered as an easier data view Large table with multi-select filters and sorted rows Markdown table rendered as an interactive chart

Diagrams, Math, Code, Media

Mermaid diagrams render offline, LaTeX math is readable, code blocks are highlighted, and Markdown can include local or streaming video.

Many Mermaid diagram types rendered in Markdown Explorer LaTeX math formulas rendered in Markdown Explorer

Syntax-highlighted code block with line numbers Markdown Explorer code block formatting example Markdown Explorer highlighted programming language sample

YouTube video embedded inside a Markdown document Streaming video preview inside a Markdown document

HTML And Media Tools

Use isolated HTML previews for interactive examples, and inspect images or diagrams in a zoomable media modal.

Interactive HTML sandbox in Markdown Explorer Rendered output from an interactive HTML sandbox

Zoomable media modal for images and Mermaid diagrams Image modal preview with zoom controls

Desktop Workspace

The desktop app opens recent folders quickly, supports drag-and-drop opening, can keep multiple workspaces alive in tabs, and automatically refreshes open workspaces from native filesystem change events without polling.

Desktop workspace selection screen Desktop workspace selection with recent folders Markdown Explorer welcome page with help section

Converted Document Previews

Markdown Explorer can optionally show DOCX, PDF, HTML, XLSX, PPTX, ODT, ODP, ODS, RTF, and TXT files by converting them to Markdown locally with @the-long-ride/markdown-them.

Turn on Read DOCX, PDF, Office, and text files in Settings. The app scans those extra extensions only after the toggle is enabled, converts files only when opened, and caches converted Markdown by file timestamp and size for faster repeat views. Converted previews are best-effort and can differ from the original layout, tables, images, or styling.

Shortcuts

Desktop shortcuts can be customized in Settings. VS Code keeps editor-friendly defaults inside the webview.

Action Desktop app VS Code
Open Markdown Explorer N/A Ctrl+Shift+M / Cmd+Shift+M
Toggle preview for current Markdown file N/A Ctrl+Alt+V / Cmd+Alt+V
Search current workspace Ctrl+F Ctrl+K / Cmd+K
Search all open workspace tabs Ctrl+Shift+F N/A
Find in current file F K
Back to previous file Ctrl+ArrowLeft or mouse back Ctrl+ArrowLeft / Cmd+ArrowLeft or mouse back
Go to next file Ctrl+ArrowRight or mouse forward Ctrl+ArrowRight / Cmd+ArrowRight or mouse forward
Go to welcome page Ctrl+H Ctrl+H / Cmd+H
Open settings Ctrl+I Ctrl+I / Cmd+I
Toggle theme Ctrl+L Ctrl+Shift+L / Cmd+Shift+L
Refresh workspace F5 Use VS Code command or reload webview
Collapse all heading sections Ctrl+Shift+X Ctrl+Shift+X / Cmd+Shift+X
Expand all heading sections Ctrl+Shift+E Ctrl+Shift+E / Cmd+Shift+E
Go to workspace selection Ctrl+Shift+H N/A
Toggle sidebar Ctrl+Shift+P Ctrl+Shift+P / Cmd+Shift+P
Sidebar cursor mode Alt+S Alt+S
Zoom in Ctrl+=, Ctrl+Plus, or Ctrl+MouseWheelUp Use editor/webview zoom
Zoom out Ctrl+- or Ctrl+MouseWheelDown Use editor/webview zoom

Privacy

  • No telemetry.
  • No file upload.
  • Local parsing, indexing, rendering, and search.
  • MIT licensed public source.

Links

Report Issues

Bug reports and feature ideas are very welcome. Clear reports make fixes faster, and screenshots or tiny sample Markdown files are especially helpful.

Before opening a new issue, please take a quick look at the existing issues so we can keep related reports together.

When you open an issue, include what you can:

  • Short title: one clear sentence, such as Search result opens wrong match.
  • App surface: VS Code extension or desktop app.
  • Version: app or extension version, plus OS.
  • Steps to reproduce: the smallest click/key sequence that triggers the problem.
  • Expected behavior: what you thought should happen.
  • Actual behavior: what happened instead.
  • Screenshot or screen recording: useful for layout, theme, zoom, and interaction bugs.
  • Minimal Markdown sample: helpful for parser, Mermaid, math, table, video, or code-block issues.
  • Console or log output: include errors from VS Code Developer Tools, Electron Developer Tools, or the terminal when available.

No need to make it perfect. A small reproducible example is already a huge gift to the project 💕.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

the-long-ride - passionate about making Markdown more enjoyable and useful for everyone. If you find this project helpful, consider starring the repository or sharing it with others who might benefit!