Markdown Explorer 🚀
Tired of reading raw Markdown files or dealing with plain, boring previews? Markdown Explorer transforms your markdown documents into a premium, interactive web-app experience right inside VS Code.
Whether you are managing complex project wikis, API documentation, or personal notebooks, Markdown Explorer gives you the power to navigate, search, inspect, and visualize your documents like never before.
Stop guessing where your files are. Markdown Explorer scans your workspace instantly to build a beautiful, interactive tree menu mapping your folders and documents. Expand folders and hop between files with zero friction.
🔍 2. Instant Global Search (Ctrl+K)
Find any document in milliseconds. Hit Ctrl+K from anywhere in the preview to summon a lightning-fast search overlay. Type a query, see matched files immediately, and jump to them instantly.
📋 3. Excel-Style Interactive Data Tables
Say goodbye to horizontal-scrolling walls of text. Tables in Markdown Explorer are interactive powerhouses:
- Frozen Headers: Column headers stay pinned to the top as you scroll through large datasets.
- Smart funnel Filters: Scans columns and auto-generates category filter dropdowns to isolate rows instantly.
- Quick Text Filtering: Instantly search inside any table via the dedicated filter input.
- Header Sorting: Click any header to sort alphanumeric series in ascending or descending order.
📊 4. One-Click Table-to-Chart Switcher
Numbers are better understood when visualized. Markdown Explorer automatically detects numeric columns and lets you instantly convert raw table data into beautiful, interactive Bar, Line, or Doughnut/Pie charts with a single click.
🎨 5. Pixel-Perfect Syntax Highlighting
Readable code is happy code. Our syntax highlighter features high-contrast rendering in both dark and light modes:
- Separated Properties & Types: Properties are highlighted in purple, while types (like
string or number) use orange, eliminating color collision.
- Readable Comments: Comments are styled in rich, high-contrast grays so they are fully legible in light mode.
- Nullable Keys Highlight: Optional properties (e.g.
email?: string) and keyword properties (default?: string) are highlighted as attributes.
👾 6. Native Mermaid Diagram Rendering
Visualize workflows, sequence flows, and database architectures inside your docs. Write standard mermaid blocks and watch them render as crisp, vector SVG graphics.
Inspect complex architectures or graphics in high definition. Click any image or diagram to open a gorgeous fullscreen modal with backdrop-blur. Zoom with your scroll wheel and drag to pan across high-res graphics seamlessly.
🚀 How to Get Started
- Install the Extension: Find us on the VS Code Marketplace and click Install.
- Launch Preview: Press
Ctrl+Shift+M (or Cmd+Shift+M on macOS, or click the preview magnifying glass icon in the title bar) to open the explorer.
- Toggle the Viewer: Press
Ctrl+Alt+V (or Cmd+Alt+V on macOS) to toggle the Markdown Explorer view on any markdown file.
- Toggle Sidebar: Click the layout icon to hide/show the tree panel to focus on writing.
- Enjoy Premium Docs: Watch your standard text render into a premium documentation hub.
🔒 Privacy, Security & Offline-First
Markdown Explorer is designed with strict privacy principles:
- 100% Offline Use: All markdown scanning, parsing, rendering, and search indexing are processed entirely on your local machine. No external servers or API requests are ever made.
- Zero Tracking: We do not collect, store, or transmit any analytics, telemetry, usage statistics, or crash reports.
- No Third-Party Tracker Libraries: No Google Analytics, no telemetry trackers, no 3rd-party analytic libraries are packaged or loaded in this extension.
- Independent: Rest easy knowing your documentation and project code never leave your local workspace.
🗺️ Roadmap & Future Enhancements
We are continuously working to make Markdown Explorer the ultimate documentation tool. Here is what is on our horizon:
- 💻 Enhanced Code Blocks: Expand syntax highlighting support to a wider range of programming languages and add premium code block layout designs.
- 🌐 Embedded HTML Support: Allow rendering of custom inline and block HTML tags inside
.md documents, passing them through unchanged.
- ⚡ MDX Support: Support rendering
.mdx files to allow component-driven interactive markdown.
- 🖥️ Standalone Desktop App: Clone and export the explorer framework to run as a standalone cross-platform desktop application.
🔗 Project Links & Contribution
