markdown-explorer

KO | EN

gitlite — search

#mysql #api #claude-code #shell #sql #gemini #redis #monitoring #awesome-list #database

markdown-explorer

(★ 9)

Markdown made clear — for people, teams, and AI. Preview, explore, search, and understand your Markdown & documents files effortlessly.

File Explorer

ZIP Download

- - release-notes.mjs
- - build-all.yml
  - deploy-website.yml
  - publish-desktop-stores.yml
  - refresh-marketplace-stats.yml
  - release.yml
  - test.yml
- launch.json
- settings.json
- tasks.json
- - icon-128.png
  - icon-16.png
  - icon-48.png
- - browser-font-host.ts
  - browser-font-service.ts
  - chrome-host-export.ts
  - chrome-host-insights.ts
  - chrome-host-search.ts
  - chrome-host-utils.ts
  - chrome-host.ts
  - current-file-watcher.ts
  - file-access.ts
  - incremental-publish.ts
  - incremental-workspace-scan.ts
  - insights-host-router.ts
  - main-chrome.tsx
  - markdown-renderer.ts
  - media-resolver.ts
  - recent-workspaces.ts
  - scanner.ts
  - search-index.ts
  - workspace-operation-state.ts
  - workspace-search-items.ts
- index.html
- manifest.json
- package.json
- popup.html
- popup.js
- tsconfig.json
- vite.config.ts
- - README.md
- chromium-install.md
- macos-install.md
- native-document-conversion.md
- workspace-insights-design.md
- - installer.nsh
- - external-open.js
  - html-preview-server.js
  - ipc-handlers.js
  - main-bootstrap.js
  - main-runtime.js
  - runtime-command-handlers.js
  - runtime-command-search-handlers.js
  - runtime-export-resources.js
  - runtime-export-save.js
  - runtime-insights-external.js
  - runtime-insights.js
  - runtime-update-handlers.js
  - runtime-utils.js
  - runtime-workspace-handlers.js
  - runtime-workspace-resources.js
  - runtime-workspace-search.js
  - startup-workspace.js
- - font-service.js
- - perf-timer.js
- - preload.js
- - document-converter.js
- - search-index.js
  - search-worker-controller.js
  - search-worker.js
  - unicode-search.js
- - update-helper.js
  - update-manager.js
  - update-state.js
- - debug-tools.js
  - tray.js
  - window.js
- - incremental-publish.js
  - recents.js
  - scanner.js
  - workspace-refresh.js
  - workspace-watch.js
- - youtube-headers.js
- main.js
- package.json
- - index.md
- image.JPG
- test-basic.md
- test-callouts.md
- test-code.md
- test-diagrams.md
- test-export-interactions.md
- test-general.md
- test-interactive.mdx
- test-large-table.md
- test-lists.md
- test-math.md
- test-media.md
- test-navigation.md
- test-tables.md
- - Better-reading-markdown-files-exp.png
  - chart-for datatable-and-CSV-TSV.png
  - chart-for datatable-and-CSV-TSV_2.png
  - Converted-Document-Preview.png
  - custom-keyboard-shortcuts-binding.png
  - Homepage.png
  - Interactive-HTML-sandbox.png
  - Math-formular-display.png
  - Mermaid-and-Image-Modal-View_1.png
  - Scope-Focus.png
  - Search-in-all-tabs.png
  - Search-in-current-opened-file.png
  - Search-in-current-workspace.png
  - Support-all-kinds-of-Mermaid-diagram.png
  - Support-display-25-programming-languages-with-beauti-format_2.png
  - support-focus-and-full-screen-mode-turn-your-document-to-presentation.png
  - Supported-HTML-File-Preview.png
  - View-data-table-easier-than-ever.png
  - VS-Code-style-mutli-workspace-multi-document-tabs.png
  - Workspace-Selection.png
  - Your-Explorer-Your-Themes.png
- configure-tauri-updater.mjs
- fetch-marketplace-stats.mjs
- sync-versions.mjs
- - markdown-explorer.desktop
- snapcraft.yaml
- - default.json
- - icon.icns
  - icon.ico
  - icon.png
- - markdown-explorer.desktop
- - run-with-global-cache.mjs
- - app_state.rs
  - debug_tools.rs
  - dispatcher.rs
  - error.rs
  - fonts.rs
  - host_message.rs
  - lib.rs
  - local_file.rs
  - main.rs
  - perf.rs
  - youtube.rs
- - parity_smoke.rs
- - explorer-hooks.nsh
- .gitignore
- build.rs
- Cargo.lock
- Cargo.toml
- package.json
- rust-toolchain.toml
- tauri.conf.json
- tauri.dev.conf.json
- tauri.dev.conf.toml
- tauri.linux.conf.json
- tauri.macos.conf.json
- tauri.microsoft-store.conf.json
- windows-app-manifest.xml
- - dead-code-removal.test.ts
  - export-runtime-followup-contract.test.ts
  - fullscreen-header-visibility.test.ts
  - host-message-parity.test.ts
  - lazy-workspace-loading.test.ts
  - markdown-parity.test.ts
  - mermaid-lifecycle-parity.test.ts
  - modal-safe-region-contract.test.ts
  - package-config.test.ts
  - platform-paths.test.ts
  - release-notes.test.ts
  - source-loc.test.ts
  - tauri-dispatcher-parity.test.ts
  - tauri-host-message-parity.test.ts
  - tauri-package-config.test.ts
  - tauri-platform-associations.test.ts
  - translations-coverage.test.ts
  - ui-style-contract.test.ts
  - website-homepage.test.ts
  - windows-explorer-installer.test.ts
  - workflow-config.test.ts
  - workspace-insights-docs-sync.test.ts
- - headerless.tsv
  - markdown-corpus.ts
  - messages.ts
  - sample-presentation.pptx
  - workspace.ts
- - chrome.ts
  - electron.ts
  - filesystem.ts
  - platform-cases.ts
  - react.tsx
  - vscode.ts
  - worker.ts
- - coverage-manifest.test.ts
  - coverage-manifest.ts
  - export-scope-coverage-manifest.ts
  - workspace-insights-coverage-manifest.ts
- - bookmark-interactions.test.mjs
  - bookmark-localization-docs.test.mjs
  - bookmark-navigation.test.mjs
  - bookmark-save-feedback.test.mjs
  - bookmark-shortcut-settings.test.mjs
  - bookmark-sidebar-ui.test.mjs
  - bookmark-source-anchor-model.test.mjs
  - bookmark-source-metadata.test.mjs
  - bookmarks.test.mjs
  - browser-font-service-behavior.test.mjs
  - browser-typography-contract.test.mjs
  - build-regressions.test.mjs
  - chart-invisible-scrollbar-legend-followup-contract.test.mjs
  - chart-modal-switch-native-save-contract.test.mjs
  - chart-pan-root-cause-followup-contract.test.mjs
  - chart-pan-shell-sizing-followup-contract.test.mjs
  - chart-viewer-footer-pan-gutter-followup-contract.test.mjs
  - chart-viewer-toolbar-refinement-contract.test.mjs
  - chart-zoom-legend-grid-followup-contract.test.mjs
  - ci-regression-contracts.test.mjs
  - content-enhancement-races.test.mjs
  - content-enhancement-scheduler.test.mjs
  - content-enhancement-tasks.test.mjs
  - content-enhancements-idempotence.test.mjs
  - content-frontmatter-comments.test.mjs
  - content-tab-close-events.test.mjs
  - delimited-text.test.mjs
  - desktop-font-model-behavior.test.mjs
  - desktop-font-model-contract.test.mjs
  - desktop-typography-contract.test.mjs
  - desktop-typography-docs-contract.test.mjs
  - desktop-typography-translations.test.mjs
  - desktop-typography-ui-contract.test.mjs
  - dialog-opacity.test.mjs
  - document-conversion-variants.test.mjs
  - electron-font-runtime-contract.test.mjs
  - electron-font-service.test.mjs
  - electron-scanner-cancellation.test.mjs
  - electron-stale-content.test.mjs
  - electron-workspace-runtime-contract.test.mjs
  - enhancements-contracts.test.mjs
  - export-center-centered-contract.test.mjs
  - export-center-responsive-contract.test.mjs
  - export-runtime-build.test.mjs
  - export-scope-localization-contract.test.mjs
  - export-static-site-followup-contract.test.mjs
  - focus-fonts-zoom-settings-followup-contract.test.mjs
  - followup-enhancements-contracts.test.mjs
  - font-dropdown-position-contract.test.mjs
  - header-layout-contracts.test.mjs
  - html-local-first-followup.test.mjs
  - html-menu-behavior.test.mjs
  - html-menus-discoverability-contracts.test.mjs
  - html-preview-content.test.mjs
  - html-preview-settings-security-followup.test.mjs
  - large-workspace-performance-contract.test.mjs
  - legacy-pdf-removal.test.mjs
  - localization-settings-doc-sync-contract.test.mjs
  - media-modal-theme-toggle.test.mjs
  - mermaid-live-rerender-contract.test.mjs
  - mermaid-manual-fixtures.test.mjs
  - mermaid-quality-behavior.test.mjs
  - mermaid-rendering-quality.test.mjs
  - mermaid-rollback-contract.test.mjs
  - packaged-runtime-contract.test.mjs
  - performance-table-tauri-contracts.test.mjs
  - product-constants.test.mjs
  - react-callback-ref-contract.test.mjs
  - read-refactored-source.mjs
  - render-once-contract.test.mjs
  - round3-contracts.test.mjs
  - scope-view-followup-contract.test.mjs
  - scope-view-responsive-contract.test.mjs
  - search-case-runtime.test.mjs
  - search-preview-host-contracts.test.mjs
  - search-preview-runtime.test.mjs
  - search-ui-contracts.test.mjs
  - settings-layout-polish.test.mjs
  - settings-navigation-update.test.mjs
  - settings-ux-followup-contract.test.mjs
  - shell-location.test.mjs
  - sidebar-files-performance-contract.test.mjs
  - sidebar-focus-search-layout.test.mjs
  - sidebar-pinning-sorting.test.mjs
  - sidebar-resize-performance-contract.test.mjs
  - source-loc-contract.test.mjs
  - startup-workspace-cancellation.test.mjs
  - table-chart-types-contract.test.mjs
  - table-chart-view-followup-contract.test.mjs
  - table-columns-contract.test.mjs
  - table-renderer-translations-contract.test.mjs
  - tauri-font-service-contract.test.mjs
  - tauri-native-document-converter.test.mjs
  - tauri-updater-contract.test.mjs
  - theme-grouping-and-styles.test.mjs
  - theme-onboarding-dropdown-visibility.test.mjs
  - theme-picker-layering.test.mjs
  - theme-remix-dropdown-visibility.test.mjs
  - typography-apply-confirmation-contract.test.mjs
  - ui-typescript-build-regression.test.mjs
  - update-dialog-runtime-contract.test.mjs
  - update-dot-size-contract.test.mjs
  - user-manual-home.test.mjs
  - vscode-explorer-action.test.mjs
  - vscode-font-service.test.mjs
  - vscode-scanner-dependency-injection.test.mjs
  - vscode-types-version-contract.test.mjs
  - website-image-viewer.test.mjs
  - windows-explorer-context-contract.test.mjs
  - windows-installer-options.test.mjs
  - workspace-operations.test.mjs
- - build-cjs-mock.ts
  - chromium.ts
  - dom.ts
  - node.ts
- tauri-cache-config.test.mjs
- - build-export-runtime.mjs
  - validate-mermaid-manual.mjs
- - App.tsx
  - AppShell.tsx
  - AppView.tsx
  - main.tsx
  - themeTypes.ts
  - types.ts
  - updateNotification.ts
  - useAppLayoutEffects.ts
  - useAppSearchEffects.ts
  - useAppUpdateActions.ts
  - vite-env.d.ts
- index.html
- package.json
- tsconfig.json
- vite.config.ts
- - bundle-markdown-them.js
  - copy-ui.js
  - verify-package-runtime.js
- - extension.ts
  - types.ts
  - utils.ts
- .vscodeignore
- CHANGELOG.md
- LICENSE
- package.json
- README.md
- tsconfig.json
- - en.js
  - es.js
  - fr.js
  - ja.js
  - ko.js
  - no.js
  - ru.js
  - vi.js
  - zh.js
- - base.css
  - homepage-hero.css
  - homepage-sections.css
  - image-viewer.css
  - legal-pages.css
  - responsive-tablet.css
  - responsive.css
  - site-components.css
  - site-foundation.css
  - site-typography.css
- google66a6f5ac290ac40f.html
- i18n.js
- index.html
- llm.txt
- marketplace-stats.json
- privacy.html
- robots.txt
- script.js
- site-download-helpers.js
- site-download-rendering.js
- site-effects.js
- site-image-viewer.js
- site-release-api.js
- sitemap.xml
- styles.css
- terms.html
- - main-web.tsx
  - virtual-workspace.ts
  - web-file-mode.ts
  - web-file-utility-router.ts
  - web-host.ts
  - web-insights-host.ts
  - web-test-host.ts
  - web-test-message-router.ts
  - web-test-search.ts
- index.html
- package.json
- tsconfig.json
- vite.config.ts
.gitignore
CHANGELOG.md
GUIDELINE.md
LICENSE
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
vitest.config.ts

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

# Project Badges

License: MIT Visit
VS Code Marketplace Visit
Open VSX Visit
Latest Release Visit

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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 support for VS Code, Chromium browsers, desktop apps (Windows, Linux, [macOS](docs/macos-install.md)), and an interactive [demo web app](https://the-long-ride.github.io/markdown-explorer/).

Homepage: [https://the-long-ride.github.io/markdown-explorer/](https://the-long-ride.github.io/markdown-explorer/)

## 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**: open `.html` and `.htm` files as interactive previews or converted Markdown (`Ctrl+Alt+H`), plus opt in to local conversion for DOCX, PDF, XLSX, PPTX, ODT, ODP, ODS, RTF, and TXT files.
- **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+Z`, 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**: CSV and TSV code fences, row sorting, multi-select table filters, collapsible datasets, and automatic Bar, Line, or Pie charts.
- **Stay private**: rendering and indexing are local. No telemetry, no file uploads.

## Installation

| Platform | Get It |
| --- | --- |
| VS Code | [Install from VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=the-long-ride.vscode-extension-markdown-explorer) |
| Open VSX | [Install from Open VSX](https://open-vsx.org/extension/the-long-ride/vscode-extension-markdown-explorer) |
| Windows desktop | [Download the latest `.exe`](https://github.com/the-long-ride/markdown-explorer/releases/latest) (or Tauri version for better performance and smaller bundle size) |
| Linux desktop | [Download `.AppImage` or `.deb`](https://github.com/the-long-ride/markdown-explorer/releases/latest) (or Tauri version for better performance and smaller bundle size) |
| macOS desktop | [Download `.dmg` for arm64 or x64](https://github.com/the-long-ride/markdown-explorer/releases/latest) (or Tauri version for better performance and smaller bundle size). First launch notes: [macOS guide](docs/macos-install.md) |
| Chromium extension | [Download `.zip` release](https://github.com/the-long-ride/markdown-explorer/releases/latest). Setup guide: [Chromium guide](docs/chromium-install.md) |
| Microsoft Store and Ubuntu App Center | Automated Tauri publishing is prepared; use [GitHub Releases](https://github.com/the-long-ride/markdown-explorer/releases/latest) until the store listings are enabled. |

## Features

<details>
<summary>Workspace Navigation & Organization</summary>

- **Workspaces & Folders**: Open local folders, manage recent workspaces, and navigate multi-workspace desktop tabs.
- **Desktop Tab & Focus Views**: Switch between multi-workspace **Tab View** for managing multiple workspaces simultaneously and **Focus View** for distraction-free single-workspace reading (`Ctrl+Alt+T` / `Ctrl+Alt+F`).
- **Workspace Feature Aliases**: Assign custom alias names to workspaces for easier identification.
- **Open Folder / File from File Explorer**: Launch folders or `.md`/`.mdx` files directly from OS File Explorer context menus. On Windows, right-clicking a file to open with Markdown Explorer automatically sets the parent directory as the active workspace.
- **Universal Hardware Mouse Navigation**: Logitech and all hardware mouse back/forward buttons (Mouse Buttons 3 and 4) along with `BrowserBack`/`BrowserForward` keys provide seamless history navigation across all runtimes.
- **macOS Native Integration**: Standard AppKit Edit application menu (Undo, Redo, Cut, Copy, Paste, Select All) and normalized 16×16 template tray icon for macOS menu bar.
- **Edit from preview**: Desktop keeps **Edit** in More actions (`Ctrl+E`), while VS Code exposes a dedicated Edit icon beside More actions (`Ctrl+Alt+E` / `Cmd+Alt+E`) to open the current `.md`/`.mdx` source in a normal editor tab. Chromium/Web does not expose Edit.
- **Locate Current File**: Highlight and reveal the currently open file in the sidebar tree using the target icon button or `Alt+Q` shortcut.
- **Sidebar Cursor Mode**: Keyboard-first file tree navigation (`Alt+Z`) with arrow keys, `Enter`, and `Esc`.
- **Content File Tabs & Scope Focus**: Open files in tabs and narrow sidebar view to selected files or folders.
- **Safer Workspace Operations**: Cancel running scans, reveal files and folders in native file manager, replace missing recent workspaces, and avoid stale scan results reopening old content.
- **Richer Context & Row Menus**: Sidebar, document-tab, and workspace-tab menus expose context-aware actions and shortcuts.
- **Relative Workspace Links**: Navigate across workspace files (`/`, `./`, `../`) with back/forward history.
- **Live Auto-Refresh**: Instant workspace tree updates from native filesystem change events.

</details>

<details>
<summary>Pin & Bookmarks</summary>

- **Sidebar Pinning**: Pin any file or folder to the top of the sidebar for fast one-click access. Pinned items inside subfolders are hoisted and displayed at the root level of the file tree.
- **Persistent Bookmarks**: Save named bookmarks from selected document text. Jump back to the exact location with search-style highlighting, and manage items through rename, delete, and three-dot or right-click menus.
- **Source-Anchored Targets**: Bookmarks store the exact Markdown source range and a fingerprint so they survive edits and relocate contextually. Multi-line, mixed-format, LaTeX, Mermaid, image, and link selections are all supported. Repeated content resolves to the saved occurrence; edited targets report **Target changed** instead of jumping incorrectly.
- **Bookmark Sidebar Tab**: Dedicated sidebar tab with live saved-count badge, sort controls, and instant search. Tab View groups bookmarks by workspace; Focus View shows only the current workspace.
- **Batch Management**: Checkbox selection mode with confirmed batch deletion (`Ctrl+Shift+B` on Desktop, `Alt+Shift+B` on VS Code / Chromium / Web).
- **Fully Localized**: All pin and bookmark labels, dialogs, empty/error states, and actions are available in English, Vietnamese, French, Spanish, Chinese, Norwegian, Japanese, Korean, and Russian.

</details>

<details>
<summary>Export & Scope View</summary>

- **All-in-One Export Center**: Export your documentation to **Standalone HTML**, **Static Website (ZIP)**, or client-side hybrid **PDF** across all runtimes.
- **Source Scopes**: Export the *Current document*, *Selected files* (with instant search filtering and multi-select checkboxes), a *Folder*, or the *Whole workspace*.
- **Flexible Layouts**: Choose between clean **Document-only** layout or **Full Explorer** interactive viewport shell (including responsive sidebar tree, search, breadcrumbs, TOC, and theme switcher).
- **Batch Modes**: Export as separate standalone files or merge multiple documents into a single document with collision-safe headings and anchor rewriting.
- **100% Offline Local Runtimes**: Zero external CDN dependencies; exports package isolated local runtime bundles for core interactions, sandboxed HTML iframe previews with automatic height synchronization, media modal inspection, table filtering/sorting, and interactive Chart.js visualizations.
- **Client-Side Hybrid PDF**: High-quality PDF generation via `pdfmake` that keeps textual content semantic, selectable, and searchable while capturing complex visual blocks (Mermaid diagrams, charts, and math) as crisp vector SVGs or raster images without opening the system print dialog.
- **Scope View Modal**: Deep-dive into linked documents in an isolated preview modal without losing your current editor or tab position.
  - **10-Step History Stack**: Bounded history stack (`MAX_SCOPE_DEPTH=10`) with animated depth indicators and Prev/Next navigation.
  - **Open File Button**: Dedicated **Open file** header button (`OpenFileIcon`) navigates the main workspace to the previewed document and closes the modal.
  - **Link Context Menu**: Right-click any Markdown link and select **Open as scope** to inspect it immediately.
  - **Hardware Navigation Parity**: Full support for keyboard (`Alt+Left`/`Alt+Right`, `BrowserBack`/`BrowserForward`, `Escape`) and hardware mouse back/forward buttons.

</details>

<details>
<summary>Document Previews & Rich Media</summary>

- **HTML Document Modes**: Open `.html` and `.htm` files as isolated interactive previews or converted Markdown, switch active tab with `Ctrl+Alt+H`, and use **Open in Browser** when full browser behavior is needed (with embedded local CSS/JS support).
- **Responsive Image Rows**: Same-paragraph Markdown images stay together across viewport sizes.
- **GFM & GitHub Callouts**: Full GFM support with callout boxes (`[!NOTE]`, `[!TIP]`, `[!IMPORTANT]`, `[!WARNING]`, `[!CAUTION]`).
- **Diagrams & Math**: Offline Mermaid diagrams (flowchart, sequence, ER, mindmap, Gantt, timeline, etc.) and KaTeX math formulas. Mermaid uses the current Markdown Explorer theme, family-aware layout profiles, and vector-safe SVG polish while preserving authored semantic styling; theme and light/dark changes re-render visible diagrams, and wide Gantt diagrams scroll before labels become unreadable. Diagrams can also be opened in the full media viewer for zoom and inspection.
- **Image & Mermaid Diagram Modal View**: Fullscreen, zoomable media modal to pan, zoom, and inspect images and Mermaid diagrams in detail.
- **Syntax Highlighting & Fences**: 25+ programming languages highlighted with line numbers, copy buttons, and terminal command fences (`bash`, `pwsh`, `sh`, `zsh`, `cmd`).
- **Interactive HTML Sandboxes**: Isolated HTML iframe previews for interactive code examples.
- **Video Embedding**: Support for local video files and YouTube/streaming video embeds.

</details>

<details>
<summary>Data Tables & Charts</summary>

- **CSV and TSV Code Fences**: Switch highlighted delimited text into interactive tables with delimiter detection, header inference, Excel-style column labels, sorting, filtering, wrapping, and chart controls.
- **Interactive Filtering & Sorting**: Multi-select column filters, row sorting, and text wrap/unwrap controls.
- **Interactive Column Visibility**: Per-table Columns dropdown menu with accessible switch toggles, **Show all**, and last-visible-column guard.
- **Collapsible Datasets**: Compact view for large datasets (1000+ rows).
- **Expanded Chart Visualizations**: Automatically convert numeric table data into 9 interactive chart types: **Bar**, **Horizontal Bar**, **Line**, **Area**, **Scatter** (with multi-numeric X/Y point mapping), **Radar**, **Polar Area**, **Pie**, and **Doughnut**.
- **Fullscreen Chart Modal Viewer**: Dedicated chart inspection viewer with 50%–1000% continuous zoom, mouse/touch pan, fit/reset, on-the-fly chart type switching, and image copy/save PNG.
- **Native Chart PNG Export**: Native file dialog and direct PNG binary export for charts on desktop runtimes.

</details>

<details>
<summary>Converted Document Previews</summary>

- **Multi-Format Local Conversion**: Opt-in previews for DOC, DOCX, PDF, HTML, XLS, XLSX, XLM, PPTX, ODT, ODP, ODS, RTF, and TXT files. Tauri performs conversion in-process with local Rust adapters; Electron and VS Code retain `@the-long-ride/markdown-them`. See [Native document conversion](docs/native-document-conversion.md).
- **Smart Caching**: Fast re-views using file timestamp and size caching.

</details>

<details>
<summary>Search & Discovery</summary>

- **Flexible Search Scopes**: Search inside current file, current workspace, or across all open desktop tabs.
- **Jump-to-Result**: Click search excerpts to jump directly to exact matches.

</details>

<details>
<summary>Customization & Platform Support</summary>

- **Built-in Theme Families & Theme Remix**: Choose grouped built-in themes—including Aurora Glass, Neon Voltage, and Raw Grid—pet themes, or create, edit, import, and export custom themes with color, density, spacing, and background image controls.
- **Keyboard Shortcuts**: Fully customizable keyboard shortcuts covering virtually all actions, navigation controls, and features in the app.
- **Desktop Store Publishing**: Automated release pipeline for signing and submitting Tauri builds to Microsoft Store and Ubuntu App Center.
- **Settings Navigation**: Settings uses a sidebar with Appearance, Typography, Theme Style, Keyboard Shortcuts, and Update & Backup sections so related controls stay focused instead of sharing one long form.
- **Typography**: Electron, Tauri, and VS Code support independent **App UI, Body, Heading, Quote, Code, and Mermaid** font bindings. Each role can choose a detected system family or an imported `.ttf`/`.otf` file plus an explicit supported style/weight. Chromium and Web runtimes persist imported `.ttf`/`.otf`/`.woff`/`.woff2` fonts in IndexedDB and activate them via the `FontFace` API.
- **Update Notifications**: Desktop releases can show a new-version dialog at startup with Download, Later, changelog, and **Skip notify for this version** actions. Skipping suppresses only that release; a newer release is shown again.
- **Cross-Platform**: Available for VS Code, Open VSX, Desktop (Electron & Tauri), and Chromium extensions.
- **Native OS Integration**: Windows File Explorer context menus and customizable desktop shortcuts.
- **Privacy First**: 100% local rendering and search with zero telemetry and no file uploads.

</details>

## Search Modes

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

## 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.

## Diagrams, Math, Code, Media

Mermaid diagrams render offline using the current Markdown Explorer theme with family-aware spacing and clean vector SVG output. Authored semantic colors remain intact, while default decorative colors follow the active theme; switching theme or light/dark mode re-renders visible diagrams, and wide Gantt diagrams scroll instead of being compressed. The media viewer remains available for zooming and inspection. LaTeX math is readable, code blocks are highlighted, and Markdown can include local or streaming video. Desktop/VS Code Typography exposes independent App UI, Body, Heading, Quote, Code, and Mermaid font bindings; code defaults to JetBrains Mono, and changing the Mermaid font re-renders diagrams in the current document.

## HTML And Media Tools

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

## Windows File Explorer

The Windows installer provides checked-by-default choices to create a desktop shortcut, add **Open with Markdown Explorer** for `.md` and `.mdx` files, and add **Open Folder in Markdown Explorer** to folder and empty-folder-background menus. Opening a Markdown file loads its containing folder as the workspace and displays that selected file. Opening a folder loads that exact folder. In Tab view this opens a workspace tab; in Focus view it replaces the current workspace. Portable and ZIP builds do not modify File Explorer automatically.

## 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. Workspace loading shows the running scan count; if a scan lasts longer than three seconds, Markdown Explorer opens with the files found so far and refreshes the tree in cumulative batches of 32 while scanning continues. An empty-workspace message appears only after scanning finishes with no supported files.

## 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.

## Keyboard Shortcuts

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

<details>
<summary>View Keyboard Shortcuts</summary>

| Action | Desktop app | VS Code extension | Chromium extension |
| --- | --- | --- | --- |
| Open Markdown Explorer | N/A | `Ctrl+Shift+M` / `Cmd+Shift+M` | N/A |
| Toggle preview for current Markdown file | N/A | `Ctrl+Alt+V` / `Cmd+Alt+V` | N/A |
| Search current workspace | `Ctrl+F` | `Ctrl+K` / `Cmd+K` | `Ctrl+K` / `Cmd+K` |
| Search all open workspace tabs | `Ctrl+Shift+F` | `Ctrl+Shift+K` / `Cmd+Shift+K` | `Ctrl+Shift+K` / `Cmd+Shift+K` |
| Find in current file | `F` | `K` | `K` |
| Back to previous file | `Ctrl+ArrowLeft` or mouse back | `Ctrl+ArrowLeft` / `Cmd+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 | `Ctrl+ArrowRight` / `Cmd+ArrowRight` or mouse forward |
| Go to welcome page | `Ctrl+H` | `Ctrl+H` / `Cmd+H` | `Ctrl+H` / `Cmd+H` |
| Edit current document | `Ctrl+E` | `Ctrl+Alt+E` / `Cmd+Alt+E` | N/A |
| Open settings | `Ctrl+,` | `Ctrl+I` / `Cmd+I` | `Ctrl+I` / `Cmd+I` |
| Toggle theme | `Ctrl+L` | `Ctrl+Shift+L` / `Cmd+Shift+L` | `Ctrl+Shift+L` / `Cmd+Shift+L` |
| Refresh workspace | `F5` | `R` | `R` |
| Collapse all heading sections | `Ctrl+Shift+X` | `Ctrl+Shift+X` / `Cmd+Shift+X` | `Ctrl+Shift+X` / `Cmd+Shift+X` |
| Expand all heading sections | `Ctrl+Shift+E` | `Ctrl+Shift+E` / `Cmd+Shift+E` | `Ctrl+Shift+E` / `Cmd+Shift+E` |
| Go to workspace selection | `Ctrl+N` | `Ctrl+Alt+W` / `Cmd+Alt+W` | `Ctrl+Alt+W` / `Cmd+Alt+W` |
| Open current document folder | `Shift+Alt+R` | N/A | N/A |
| Toggle sidebar | `Ctrl+B` | `Alt+A` | `Alt+A` |
| Toggle table of contents | `Ctrl+T` | `Alt+C` | `Alt+C` |
| Locate current file | `Alt+Q` | `Alt+Q` | `Alt+Q` |
| Toggle Focus mode | `Ctrl+Alt+F` | `Ctrl+Alt+F` / `Cmd+Alt+F` | `Ctrl+Alt+F` / `Cmd+Alt+F` |
| Toggle active HTML document view | `Ctrl+Alt+H` | `Ctrl+Alt+H` / `Cmd+Alt+H` | `Ctrl+Alt+H` / `Cmd+Alt+H` |
| Toggle desktop Tabs/Focus view | `Ctrl+Alt+T` | N/A | N/A |
| Close current content tab | `Ctrl+W` | N/A | N/A |
| Close all content tabs | `Ctrl+Shift+W` | N/A | N/A |
| Close content tabs to the right | `Ctrl+Alt+W` | N/A | N/A |
| Close other content tabs | `Ctrl+Alt+O` | N/A | N/A |
| Toggle fullscreen | `F11` | N/A | N/A |
| Sidebar cursor mode | `Alt+Z` | `Alt+Z` | `Alt+Z` |
| Zoom in | `Ctrl+=`, `Ctrl+Plus`, or `Ctrl+MouseWheelUp` | Use editor/webview zoom | Use browser zoom |
| Zoom out | `Ctrl+-` or `Ctrl+MouseWheelDown` | Use editor/webview zoom | Use browser zoom |
| Reset zoom | `Ctrl+Alt+Z` | Use editor/webview zoom | Use browser zoom |

</details>

## Privacy

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

## Links

- [Website](https://the-long-ride.github.io/markdown-explorer/)
- [Demo Web App](https://the-long-ride.github.io/markdown-explorer/)
- [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=the-long-ride.vscode-extension-markdown-explorer)
- [Open VSX](https://open-vsx.org/extension/the-long-ride/vscode-extension-markdown-explorer)
- [Latest GitHub Release](https://github.com/the-long-ride/markdown-explorer/releases/latest)
- [Changelog](https://github.com/the-long-ride/markdown-explorer/blob/main/CHANGELOG.md)
- [Issues](https://github.com/the-long-ride/markdown-explorer/issues)

## 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](https://github.com/the-long-ride/markdown-explorer/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](LICENSE) file for details.

## Author

[the-long-ride](https://github.com/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!

markdown-explorer

File Explorer

# Use via CDN

# Project Badges

Was this content helpful?

Recent Feedback

Download README