Back to Lab
Experimental #electron#markdown#desktop#open-source

mdv: a desktop Markdown viewer

A small Electron app for reading folders of Markdown: file tree, tabs, a table of contents that follows you, and print/PDF export.

View on GitHub

mdv is a desktop Markdown viewer built on Electron. Point it at a folder and it shows the Markdown files in a tree that updates as files change; open documents side by side in tabs and read them with a table of contents that follows the scroll position.

mdv in the dark theme

What it does

  • File tree of the Markdown files in a folder, updated as files change
  • Multiple documents in tabs
  • Automatic table of contents that follows the scroll position
  • GitHub-flavoured Markdown: tables, task lists, alerts, footnotes, emoji
  • Syntax highlighting (Shiki), math (KaTeX) and diagrams (Mermaid)
  • Light and dark themes
  • Live reload when a document changes on disk
  • Print and PDF export

Try it

mdv needs Node.js 22.22.2 or newer on the 22 line, or 24.15 or newer. To run it from source:

git clone https://github.com/blackshieldpt/mdv
cd mdv
npm install
npm run dev -- <file-or-folder>

Packages for Linux (deb, snap), Windows and macOS can be built with make; see the README for details.

mdv is open source under the Apache 2.0 license.