explaingit

jensen-yao/mdre

★ 23HTMLAudience · writer

TLDR

A lightweight local document reader for Windows, Android, and Linux that renders Markdown files, HTML pages, Mermaid diagrams, and math formulas without requiring an account or internet connection.

Mindmap

mindmap
  root((MDre))
    Platforms
      Windows
      Android
      Linux
    Formats
      Markdown
      HTML
      Plain text
    Features
      Syntax highlighting
      Math formulas
      Mermaid diagrams
      Translation
    Extras
      AI question mode
      Heading navigation
      Theme support
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Read and preview Markdown files with rendered tables, code blocks, and Mermaid diagrams on Windows, Android, or Linux without a heavy editor.

USE CASE 2

Translate selected text in a document to another language using Baidu Translate, DeepL, or a DeepSeek API while reading on Windows.

USE CASE 3

View local HTML pages and embedded Mermaid diagrams entirely offline without opening a browser.

USE CASE 4

Ask AI-powered questions about the content of a document using the app's built-in AI mode.

Tech stack

HTMLMermaidMarkdown

In plain English

MDre is a lightweight document reader for Windows, Android, and Linux that opens and displays Markdown and HTML files stored on your device. The README is written in Chinese, but the project description and download links are straightforward: it is a local-first reader with no account required and no telemetry. The app handles common document formats including .md.markdown.txt.html, and .htm files. It renders Markdown tables, task checkboxes, code blocks with syntax coloring, mathematical formulas (using a renderer the author says outperforms VS Code's built-in), Mermaid diagrams, and local image previews. Static HTML pages are also previewed, and the app can detect and render Mermaid diagram snippets embedded in those pages. Additional features include document text search, heading-based navigation, a recent files list, page color themes, and a basic editing mode for quick changes. On Windows, you can select text and translate it using Baidu Translate, DeepL, or any DeepSeek-compatible API that you configure. On Android the app relies on the device's built-in system translation. There is also an AI-powered mode for asking questions about a document's content, though the README does not specify which AI service it connects to. The Android package is about 5 MB. The Windows and Linux builds are available from the project's Releases page. The current version is 1.0.0 alongside an earlier 0.1.24 build, and the Linux release is at 0.1.2.

Copy-paste prompts

Prompt 1
I have MDre installed on Windows and want to connect it to the DeepSeek API for translation. What does the configuration look like and what API key format does it expect?
Prompt 2
I want to write a Markdown file that includes a Mermaid diagram, a math formula, and a table so I can preview it in MDre. Write me a sample .md file I can open right away.
Prompt 3
I use MDre on Android and want to read a long Markdown document with headings. How do I use the heading-based navigation to jump between sections?
Open on GitHub → Explain another repo

← jensen-yao on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.