Skip to content

Repository files navigation

ReadMD - Simple , small - just does the work Open any Md , txt files easily

Native desktop app for opening, editing, and exporting Markdown, HTML, and text files. Local-first — not a website. Windows and Linux.

Download

Latest: GitHub Releases

Windows

File What it is
readmd_*_x64-setup.exe Installer (recommended)
readmd_*_x64_en-US.msi MSI installer
readmd.exe Portable app binary

Linux

File What it is
readmd_*_amd64.AppImage Portable app (recommended)
readmd_*_amd64.deb Debian / Ubuntu package

Make the AppImage executable: chmod +x readmd_*.AppImage, then run it.

Installed copies check GitHub Releases for newer versions and show an Update now bar. Command palette → Check for updates.

Tag a version (v0.3.6) to cut a new release. GitHub Actions builds Windows and Linux installers, signs updater artifacts, and publishes latest.json.

Features

  • Reader, split, and editor views with live preview

  • CommonMark rendering via markdown-it, plus tables, task lists, callouts, and math

  • Images from https URLs, paste/drop with short img/ links (not base64), and files next to the document

  • Split-view scroll sync between editor and preview

  • Outline, command palette (Ctrl+K), find and replace (Ctrl+F / Ctrl+H)

  • Idle auto-save for files already on disk

  • In-app updates from GitHub Releases

  • Export PDF, DOCX, and clean TXT

  • HTML files and raw HTML in Markdown

  • Remembers recent files and last folders

  • Offline, no account

  • image
  • image
image image

Develop

Needs Node.js and Rust. On Linux also install WebKitGTK 4.1 (see the release workflow).

npm.cmd install
npm.cmd run desktop:dev

Build installers:

npm.cmd run desktop:build

Frontend-only (browser fallback):

npm.cmd run dev

About

About ReadMD is a native desktop app for Markdown, not a VS Code extension ; Double-click a `.md`, `.txt`, or `.html` file and work in a dedicated window: Reader, Split, or Editor. The preview updates as you type, including math and images. Paste or drop a picture , it just works Export as PDF, Docs , txt , print everything just works

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages