ReadMD

About

ReadMD turns your browser into a beautiful local Markdown reader — no upload, no sync, no cloud. Your files stay on your device.

  WHY INSTALL READMD?

  If you write documentation, take notes in Markdown, or work with README files, you know the pain: opening a .md file in the
  browser gives you raw text. ReadMD fixes that instantly.

  WHAT IT DOES

  • Browse any local folder — open a directory and see all your .md files in a clean sidebar tree
  • Render beautifully — headings, lists, tables, code blocks with syntax highlighting, images, and blockquotes all rendered as
  intended
  • Table of Contents — auto-generated TOC panel with click-to-jump navigation and scroll-based active heading tracking
  • Split view — open two files side by side for comparison or reference
  • Dark mode — easy on the eyes for long reading sessions
  • Math & diagrams — KaTeX for LaTeX math formulas, Mermaid for flowcharts and sequence diagrams
  • Direct file access — paste any file:///path/to/file.md in the address bar and ReadMD opens it automatically
  • Navigate between files — follow Markdown links across files, with back/forward history
  • Refresh on demand — reload the current file or rescan the directory without reopening
  • Bilingual UI — switch between English and Chinese at any time

  WHO IS IT FOR?

  • Developers reading project documentation and READMEs offline
  • Writers and students who keep notes in Markdown
  • Anyone who works with local knowledge bases (Obsidian vaults, Logseq folders, etc.)
  • Technical writers reviewing docs before publishing

  PRIVACY

  ReadMD is 100% local. It never uploads, syncs, or shares your files. No analytics. No tracking. No server. Full privacy policy:
  https://davidliuxh.github.io/readmd/privacy/

————————————————————————————————
ReadMD 让你的浏览器变成一个美观的本地 Markdown 阅读器——无需上传、无需同步、无需联网。你的文件始终留在本地设备上。

  为什么安装 ReadMD？

  如果你用 Markdown 写文档、记笔记或阅读 README，一定遇到过这个困扰：在浏览器直接打开 .md 文件只能看到一堆原始文本。ReadMD
  一键解决这个问题。

  核心功能

  • 目录树浏览 — 打开本地文件夹，所有 .md 文件以清晰的侧边栏树形结构展示
  • 精美渲染 — 标题、列表、表格、代码块（带语法高亮）、图片、引用块，完整还原 Markdown 样式
  • 大纲导航 — 自动生成文章目录，点击跳转，滚动时自动高亮当前章节
  • 分屏对比 — 左右并排打开两个文件，方便对照阅读
  • 暗色主题 — 护眼深色模式，长时间阅读更舒适
  • 数学与流程图 — 支持 KaTeX 渲染 LaTeX 数学公式，支持 Mermaid 绘制流程图和时序图
  • 直接打开文件 — 在地址栏粘贴任意 file:///路径/文件.md，ReadMD 自动接管渲染
  • 文件间跳转 — 支持跟随 Markdown 内链跳转，保留前进/后退导航历史
  • 手动刷新 — 文件内容或目录变化后，可单独刷新当前文件或重新扫描目录
  • 中英双语界面 — 随时切换中文与英文显示

  适合哪些人？

  • 离线阅读项目文档和 README 的开发者
  • 用 Markdown 写笔记的写作者和学生
  • 使用本地知识库的用户（Obsidian、Logseq 等目录结构）
  • 发布前在本地预览文档的技术写作者

  隐私说明

  ReadMD 完全本地运行，不上传、不同步、不共享任何文件内容。无数据收集，无行为追踪，无远程服务器。完整隐私政策：https://davidliuxh.g
  ithub.io/readmd/privacy/