Server · #435 trending MCP repo

readMD

Natsummerance/readMD

本地优先的全平台 Markdown 阅读器与编辑器:长文档语义分页、显示层非破坏纠错、Office/PDF/网页转 MD、离线 OCR、LaTeX 学术增强与 MCP 接入。官网地址:https://readmd.asia ; 爱发电:https://ifdian.net/a/natsummerance

Stars
25
This week
-1
Forks
2
Open issues
0
Skills inside
68
Star trend · last 9 days-1 ★
Oct 29, 2026: 26 starsOct 30, 2026: 26 starsOct 31, 2026: 26 starsNov 1, 2026: 26 starsNov 2, 2026: 26 starsNov 3, 2026: 26 starsNov 4, 2026: 26 starsNov 5, 2026: 26 starsNov 6, 2026: 25 starsNov 7, 2026: 25 stars

Inside this repo

48 of 68 skills

academic-paper-workflowUse when a user needs to plan, compose, or revise an academic paper in a staged workflow.assets/skills/academic-paper-workflowavoid-ai-writingUse when outward-facing Markdown should avoid recognizable machine-written patterns while retaining its claims.assets/skills/avoid-ai-writingcareer-writingUse when a resume, cover letter, portfolio case study, or job application needs evidence-based editing.assets/skills/career-writingcreative-writing-craftUse when fiction or creative Markdown needs stronger character, scene, voice, or narrative craft.assets/skills/creative-writing-craftreadmd-askUse when a user needs a grounded answer based only on a Markdown document.assets/skills/readmd-askreadmd-code-analysisUse when source code or a configuration file needs a factual logic and risk analysis.assets/skills/readmd-code-analysisreadmd-code-reviewUse when code blocks in a Markdown document need a security, correctness, and maintainability review.assets/skills/readmd-code-reviewreadmd-code-to-docUse when source code or a configuration file should become a structured Markdown document.assets/skills/readmd-code-to-docreadmd-continueUse when a Markdown document needs a coherent continuation that matches its established voice and logic.assets/skills/readmd-continuereadmd-export-styleUse when a ReadMD export needs a validated typography style represented as JSON.assets/skills/readmd-export-stylereadmd-format-fixUse when Markdown rendering is broken by malformed tables, formulas, code fences, links, or heading structure.assets/skills/readmd-format-fixreadmd-humanizerUse when generated prose needs to sound natural, specific, and consistent with a human author's voice.assets/skills/readmd-humanizerreadmd-localizationUse when translating or reviewing ReadMD interface strings for a target locale.assets/skills/readmd-localizationreadmd-outlineUse when a document needs a clear hierarchical Markdown outline before editing or writing.assets/skills/readmd-outlinereadmd-polishUse when Markdown prose needs natural, precise editorial polishing without changing its meaning or structure.assets/skills/readmd-polishreadmd-proofreadUse when a Markdown document needs publication-grade language, punctuation, and format proofreading.assets/skills/readmd-proofreadreadmd-quick-readUse when a Markdown document needs a structured, high-signal reading brief.assets/skills/readmd-quick-readreadmd-skill-creatorUse when a ReadMD user wants to design, test, or improve a reusable document-writing Skill.assets/skills/readmd-skill-creatorreadmd-style-customGenerate custom CSS rules and HTML head tags for ReadMD document styling.assets/skills/readmd-style-customreadmd-summaryUse when a Markdown document needs a short, high-value executive summary.assets/skills/readmd-summaryreadmd-todoUse when notes or a Markdown document need actionable tasks and decisions extracted.assets/skills/readmd-todoreadmd-translateUse when a Markdown document must be translated accurately while preserving its technical structure.assets/skills/readmd-translatereadmd-weeklyUse when work notes need to become a structured professional weekly report.assets/skills/readmd-weeklyresearch-paper-writingUse when a research Markdown document needs a rigorous argument, evidence chain, or publication-ready section.assets/skills/research-paper-writingwriting-skillsUse when a user is creating or revising a ReadMD Skill and needs a test-first writing workflow.assets/skills/writing-skillshumanizerRewrite AI-sounding text so it reads naturally without changing what it says. Use when editing or reviewing prose for inflated claims, sales language, vague sources, repetitive structure, stock AI words, passive voice, filler, or chatbot artifacts. Based on Wikipedia's "Signs of AI writing."assets/upstream/blader-humanizer/e2e92e7b4b8229253ed5c8e81dc65463fdeddda5humanizerRemove signs of AI-generated writing from text. Use when editing or reviewing text to make it sound more natural and human-written. Based on Wikipedia's comprehensive "Signs of AI writing" guide. Detects and fixes patterns including: inflated symbolism, promotional language, superficial -ing analyseassets/upstream/codex-humanizer/localskill-creatorCreate or update a Codex skill with appropriately scoped instructions and any needed supporting resources.assets/upstream/codex-skill-creator/sha256-cccd291077ec57c6f50ca6529f0f3fb93212da09473effb2fcec808e81b21288writing-skillsUse when creating new skills, editing existing skills, or verifying skills work before deploymentassets/upstream/codex-writing-skills/localavoid-ai-writingAudit and rewrite content to remove AI writing patterns ("AI-isms"). Use this skill when asked to "remove AI-isms," "clean up AI writing," "edit writing for AI patterns," "audit writing for AI tells," or "make this sound less like AI." Supports a detect-only mode, an edit-in-place mode for files, anassets/upstream/conorbronsdon-avoid-ai-writing/40328bd292bc682d46010a6f9ac2cdbf4fb4cecaavoid-ai-writingAudit and rewrite content to remove AI writing patterns ("AI-isms"). Use this skill when asked to "remove AI-isms," "clean up AI writing," "edit writing for AI patterns," "audit writing for AI tells," or "make this sound less like AI." Supports a detect-only mode, an edit-in-place mode for files, anassets/upstream/conorbronsdon-avoid-ai-writing/40328bd292bc682d46010a6f9ac2cdbf4fb4ceca/plugins/avoid-ai-writing/skills/avoid-ai-writingcharacter-simSpeak as a specified character from their current knowledge, voice, and emotional state. Use for skill-only workflows that need in-character conversation, voice discovery, or relationship pressure tests.assets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/character-simcreative-researchLoad when a story needs factual grounding the writer doesn't have: historical detail, cultural texture, domain accuracy, or how other authors handled similar material. Pass the question and story context; returns a sourced report the writer can draw from.assets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/creative-researchcreative-writing-craftCraft references for writing fiction well: prose, scenes, style, voice, and genre/page-level technique. Load when a writer, critic, or muse needs how-to-write guidance rather than a production mode.assets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/creative-writing-craftcreative-writing-modesCreative-writing addendum to /llm-writing. Load when putting prose on the page: draft, revise, bridge, vary, or polish.assets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/creative-writing-modescreative-writing-museLoad when no subagents are available and one agent must plan, draft, critique, research, and capture memory by switching stances.assets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/creative-writing-musereader-simRead as a specified first-time reader persona and report the felt experience. Use for skill-only workflows when a draft needs persona-bound reader-response signal instead of analytical critique.assets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/reader-simstory-memoryCreative-writing domain knowledge for durable story state. Load when preserving or retrieving project memory — fact extraction, context scoping, reference writing, artifact layout, and issue tracking. If you are a knowledge agent such as kb-lead, load this for the fiction-specific categories and conassets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/story-memorystory-planningPlanning work before prose: creative direction, story-planning, outlining, and story architecture. Load when deciding what should happen or how a story should be structured.assets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/story-planningstory-reviewReview work after prose exists: editorial review, craft critique, continuity/voice review, copyediting, proofreading, and synthesis of reader-sim signal. Load when diagnosing a draft rather than rewriting it.assets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/story-reviewwriting-principlesWhat fiction readers want (reader reward channels) and the specific ways LLM training damages them. Load when drafting prose, critiquing, or diagnosing why a passage feels flat.assets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/writing-principleswriting-staffingDispatch reference for composing writing teams. Teaches which extra skills to attach via --skills, which resources to reference in spawn prompts, and when to fan out versus run parallel lanes. Load when staffing a workflow.assets/upstream/haowjy-creative-writing-skills/fd7a3ad9cd7697a0645ff6ff4bd5e809cf7673a3/skills/writing-staffingacademic-paper-composerSystematic writing framework for philosophy and interdisciplinary academic papers from optimized outline to submission-ready manuscript. Use when users want to: (1) write a paper from a detailed outline, (2) ensure quality control during writing, (3) maintain consistency across chapters, (4) prepareassets/upstream/lishix520-academic-paper-skills/c325557646e9418939ccc7b99171b149ad6314f1/composeracademic-paper-strategistSystematic strategic planning framework for philosophy and interdisciplinary academic papers targeting preprint platforms (PhilArchive, arXiv, PhilSci-Archive). Use when users want to: (1) plan a paper on a specific topic, (2) identify research gaps and assess originality, (3) develop optimized papeassets/upstream/lishix520-academic-paper-skills/c325557646e9418939ccc7b99171b149ad6314f1/strategisttest-driven-developmentUse when implementing any feature or bugfix, before writing implementation codeassets/upstream/obra-superpowers/b36e0829c6d0140e93cfef2ca599b1b07d4a7797/skills/test-driven-developmentwriting-skillsUse when creating new skills, editing existing skills, or verifying skills work before deploymentassets/upstream/obra-superpowers/b36e0829c6d0140e93cfef2ca599b1b07d4a7797/skills/writing-skillsacademic-cv-builderFormat CVs for academic positions with publications, grants, and teachingassets/upstream/paramchoudhary-ResumeSkills/74ae19e7c62b0516d1c298328e5544976c12da5d/skills/academic-cv-builderapplication-form-fillerFill out job application form fields with context-aware, tailored answers drawn from the candidate's CV and the job descriptionassets/upstream/paramchoudhary-ResumeSkills/74ae19e7c62b0516d1c298328e5544976c12da5d/skills/application-form-filler

Documentation

README

View on GitHub ↗

Languages: 简体中文 | 繁體中文 | English | 日本語

ReadMD logo

ReadMD (Pure Rust Edition)

100% 纯 Rust 原生全平台 Markdown 阅读器与编辑器

长文档语义分页 · 显示层非破坏纠错 · Office/PDF/网页转 MD · 离线 OCR · LaTeX 学术增强 · MCP 接入 · 零 Python 依赖

官网地址:https://rust.readmd.asia | 赞助支持(爱发电):https://ifdian.net/a/natsummerance

[!IMPORTANT] 100% Pure Rust 原生架构版 (rust-ReadMD):本项目由全新纯 Rust 内核(readmd-kernel)独立驱动,彻底移除了所有历史 Python 运行时与虚拟环境依赖。体积仅约 11.8MB,冷启动毫秒级秒开,常驻内存下降 80%+。支持 Windows (WebView2 + Win32)、macOS (WKWebView + Cocoa) 与 Linux (WebKitGTK + XDG) 全平台原生运行,零外部依赖,安全纯粹。

platform i18n license release website

30 秒判断它适不适合你

你的情况 ReadMD 的做法
文件超过 8,000 行或 500KB 自动启用语义分页;目录和 Ctrl+F 跨页联动
表格缺分隔线或公式未闭合 渲染前在内存修正;原文件仍保持不变
手里有 DOCX / PPTX / XLSX / PDF / HTML 一键转入 Markdown,减少手工搬运
需要提取扫描件文字 调用系统原生 OCR,支持离线工作流
写论文或技术文档 BibTeX 引用卡片、定理/证明盒子与 LaTeX 导出
想要桌面伴读或角色互动 CC0 Arch-Chan Live2D 与 73 款微呼吸精灵图,全端台词同步
需要高保真修复 PDF 文本 内置矢量 PDF 编辑器,零污染质检与一键回滚
想接入 AI 编程助手 提供 VS Code 扩展和 FastMCP stdio Server (21 项工具)
多语言团队跨国协作 46 国语言 100% 字典对齐 (1563 词条),零英文照搬,母语级体验

直接下载

Windows 安装包 · Windows 便携版 · macOS Apple Silicon · macOS Intel · Linux AppImage · Linux ARM64 · UOS / 麒麟 Deb · 麒麟 V10 ARM64 · SHA-256

三步开始

  1. 按系统下载安装包,或选择免安装便携版。
  2. 打开一个真实的大文件;先检查目录、搜索和表格渲染。
  3. 需要修改时再编辑保存;自动修复不会在你不知情时改写源文件。

AI 助手引用入口

为什么值得 Star

ReadMD 解决的是长期资料库里的实际问题:大文件能继续读,导入稿不用重排,敏感内容可以留在本机,原文始终保留最终决定权。如果你在 Windows、macOS、Linux 或信创环境之间切换,它提供一致的工作流。

如果它帮你省下一次整理时间,请 点 Star,让更多写作者找到这个项目。

候选下载矩阵 (Preview Release Assets)

本矩阵只列当前候选的交付目标,不等同于正式支持承诺。Windows 7 仅提供单独的遗留运行时构建,不与 Windows 10/11 安装包混装;HarmonyOS/OpenHarmony 及未完成实机验收的架构不属于 V0.0.1 支持范围。

操作系统 / 平台 架构 / 格式 直接下载链接 (GitHub Release) 说明
Windows x64 (安装版) ⬇️ ReadMDSetup-v0.0.1.exe 动画安装向导,自动关联 .md 文件为默认打开方式
Windows x64 (绿色便携版) ⬇️ ReadMD-portable-v0.0.1.exe 单文件绿色版,免安装解压即用
macOS Apple Silicon (M系列) ⬇️ ReadMD-macos-arm64-v0.0.1.zip M1 / M2 / M3 / M4 原生构建(含 Vision 离线 OCR)
macOS Intel x86_64 ⬇️ ReadMD-macos-x64-v0.0.1.zip Intel 芯片 Mac 原生构建(含 Vision 离线 OCR)
Linux x86_64 (AppImage) ⬇️ ReadMD-linux-x86_64-v0.0.1.AppImage 通用 Linux 免安装 AppImage,赋予执行权限后直接运行
Linux ARM64 (AppImage) ⬇️ ReadMD-linux-aarch64-v0.0.1.AppImage 飞腾 / 鲲鹏等 ARM64 设备免安装运行
国产信创系统 统信 UOS / 银河麒麟 / Deepin / Ubuntu ⬇️ readmd_0.0.1_amd64.deb Deb 原生安装包;需以对应系统的实机验收记录为准
️ 麒麟 V10 / 飞腾 ARM64 (aarch64) ⬇️ readmd_0.0.1_arm64.deb 飞腾 D2000/E2000 原生构建,内置 UKUI/X11 与软件渲染安全回退
VSCode 插件 通用 VSIX 扩展包 ⬇️ readmd-vscode-0.0.1.vsix VSCode 离线安装包,支持双向同步预览与格式自愈
MCP Server FastMCP stdio 独立包 ⬇️ readmd-mcp-server-0.0.1.zip 独立 FastMCP 服务端,供 Claude Desktop / Cursor 一键接入
SHA-256 校验 完整性清单 ⬇️ SHA256SUMS.txt 全量资产 SHA-256 哈希校验清单

多系统与信创国产适配

1. Linux 与国产操作系统适配(统信 UOS / 银河麒麟 / 深度)

  • 直接安装使用:下载 readmd_0.0.1_amd64.deb 双击安装,或直接运行 ReadMD-linux-x86_64-v0.0.1.AppImage。银河麒麟 V10 + 飞腾 ARM64 设备使用 readmd_0.0.1_arm64.deb。
  • 飞腾安全回退:自动识别 Phytium D2000/E2000/FT 系列;WebKitGTK 启动时优先选择 UKUI/X11、禁用 DMABUF 合成并回退 llvmpipe,避免旧 GPU 驱动白屏或崩溃。
  • 系统与环境识别:100% 纯原生 Rust 内核(native_system)自动识别系统发行版,自适应配置 Wayland / X11 显示后端。
  • 桌面与深色模式:自动侦测 DDE(统信/Deepin)、UKUI(银河麒麟)与 GNOME/KDE 的外观主题,实时同步深色/浅色配色。
  • 桌面集成与关联:内置 FreeDesktop 桌面入口与 MIME 类型声明,支持双击 .md 默认打开。
  • 支持边界:本版本不宣称 openEuler、玲珑或其他未列出的发行版具备完整原生支持。

2. Windows & macOS 平台特性

  • Windows:内置 WinRT 原生 OCR、WebView2 硬件加速渲染、系统托盘常驻与智能单实例通信。
  • macOS:原生 Apple Vision 离线文字识别、WebKit 视窗引擎、跟随系统外观与 Touch Bar 快捷操作。

桌面伴读宠物系统 (Live2D & 73 款微呼吸精灵图)

  • CC0 Arch-Chan Live2D:高精 Live2D 骨骼动画,随阅读进度与时段动态互动,支持平滑拖动、鼠标穿透和高灵敏点击命中。
  • 73 款 Petdex 精灵图自适应与活态微呼吸:内置几何自动推断算法,零延迟智能适配高密序列帧与单立绘小图,彻底杜绝撕裂错位;脚底锚点正弦微呼吸浮动赋予生动生命感。
  • 伴读伴侣生活状态引擎:等级、体力、心情、亲密度成长系统,支持摸摸头、喂食、玩耍、休息、唤醒等互动。
  • 全端气泡联动:桌面悬浮窗、应用内桌宠小部件、设置面板舞台三端实时同步对话台词,Electron 托盘右键菜单无缝下发。
  • 高定苹果风原生滑块 (/apple-design):采用 Apple HIG 4px 极简精致轨道与 18px 实体物理质感悬浮圆钮,Active 触觉光晕与等宽数字药丸读数。

原生高保真矢量 PDF 编辑器

  • 结构与微观审计:自动审计 PDF 几何尺寸、DPI、旋转、系统文件锁,并对指定区域进行底色与噪点采样。
  • 零污染差分质检 (Zero-Contamination Gate):沙箱模拟编辑并自动生成对比图与热力图,未通过复核绝不写入原文件。
  • 安全无损落盘与一键回滚:落盘前强制生成 .bak 物理备份,解锁 Windows 只读属性;支持一键回滚恢复初始状态。

VSCode 扩展与 MCP Server 生态

1. VSCode 插件安装与使用

  • 界面安装:下载 readmd-vscode-0.0.1.vsix -> 在 VSCode 扩展面板选择 ... -> 从 VSIX 安装...。
  • 命令行安装:
code --install-extension readmd-vscode-0.0.1.vsix
  • 核心功能:打开 Markdown 文件点击右上角书本图标开启同步预览;右键菜单支持一键自动修复语法错误与转换为 LaTeX 源码。

2. MCP (Model Context Protocol) Server 配置

直接下载解压 readmd-mcp-server-0.0.1.zip,在 Claude Desktop、Cursor、Antigravity 与 Cline 中配置(请将 args 中的路径替换为本机解压的绝对路径):

Windows:

{
  "mcpServers": {
    "readmd": {
      "command": "python",
      "args": ["C:\\path\\to\\readmd\\packages\\mcp-server\\readmd_mcp_server.py"],
      "env": {
        "PYTHONIOENCODING": "utf-8"
      }
    }
  }
}

macOS / Linux:

{
  "mcpServers": {
    "readmd": {
      "command": "python3",
      "args": ["/path/to/readmd/packages/mcp-server/readmd_mcp_server.py"],
      "env": {
        "PYTHONIOENCODING": "utf-8"
      }
    }
  }
}

注意:必须使用脚本的完整绝对路径,不能使用相对路径;Windows 路径中的反斜杠必须写为 \\ 或改用正斜杠 /。推荐配置 PYTHONIOENCODING=utf-8 以确保跨平台编码一致。


LaTeX PRO 学术增强与 BibTeX 引用

  1. BibTeX 自动扫描与引用卡片:
  • 自动扫描同目录下 .bib 参考文献文件;
  • 文中书写 [@vaswani2017attention] 或 @author2024 自动渲染为引用徽章;
  • 悬停徽章展示论文标题、作者、年份、DOI 链接并支持一键复制 BibTeX;文末自动汇总生成参考文献表。
  1. 学术 Callout 盒子:
  • ::: theorem [定理名称] / ::: lemma [引理名称] / ::: definition [概念定义]
  • ::: proof 证明块自动添加文末 Q.E.D. ■ 符号。

Editor Studio PRO 沉浸编辑

  • Zen Mode 禅模式:按 F11 或点击编辑栏「 禅模式」全屏专注写作,按 Esc 退出。
  • 10×10 可视化表格设计器:鼠标自由滑选行列生成工整 Markdown 表格。
  • 智能表格粘贴:复制 Excel、WPS、Numbers 或网页表格,在编辑器中直接粘贴为 Markdown 表格。
  • 实时文档统计:实时显示中文字数、西文词数与预计阅读时间。

全球 46 语种 i18n 全量母语化

ReadMD 提供 46 个 locale;每次发布均校验键、占位符与方向一致性。候选版的语义翻译质量和原生平台可用性以对应验收证据为准,不以静态字典数量替代实测。

分区 覆盖语言 详细语言列表
东亚 (6语) 中文/日/韩/蒙 简体中文 (zh-CN)、繁体中文·香港 (zh-HK)、繁体中文·台湾 (zh-TW)、日本語 (ja)、한국어 (ko)、Монгол хэл (mn)
欧洲主流 (19语) 西欧/中欧/东欧/北欧 English (en)、Français (fr)、Deutsch (de)、Español (es)、Português (pt)、Русский (ru)、Italiano (it)、Nederlands (nl)、Türkçe (tr)、Ελληνικά (el)、Magyar (hu)、Українська (uk)、Hrvatski (hr)、Slovenščina (sl)、Română (ro)、Dansk (da)、Norsk (no)、Svenska (sv)、Suomi (fi)
中东与南亚 (7语) 阿/希/维/藏/印/孟/尼 العربية (ar, RTL)、עברית (he, RTL)、ئۇيغۇرچە (ug, RTL)、བོད་སྐད། (bo)、हिन्दी (hi)、বাংলা (bn)、नेपाली (ne)
东南亚 (8语) 泰/越/印尼/马/缅/老/高棉/菲 ภาษาไทย (th)、Tiếng Việt (vi)、Bahasa Indonesia (id)、Bahasa Melayu (ms)、မြန်မာဘာသာ (my)、ພາສາລາວ (lo)、ភាសាខ្មែរ (km)、Tagalog (tl)
特色与区域 (6语) 爱/马耳他/格陵兰/世界/非 Gaeilge (ga)、Malti (mt)、Kalaallisut (kl)、Esperanto (eo)、Ikinyarwanda (rw)、Kikongo (kg)

详细规范与词条清单:docs/i18n-language-reference.md


核心功能与使用指南

  • 自动修正:表格缺线对齐补全、加粗与公式未闭合自动闭合、#标题 补空格,修正详情在「 修复」面板中清晰展示。
  • 万物转 MD:支持 Word、PowerPoint、Excel、PDF、HTML、LaTeX 等批量或拖拽转换,转换后自动在新标签页打开。
  • 扫描 OCR:Windows (WinRT) 与 macOS (Vision) 本地离线识别,剪贴板截图一键提取文字。
  • 网页转 MD:Trafilatura 智能抽取正文,动态单页应用自动通过无头 WebView 渲染提取。
  • 局域网共享:点击工具栏「」生成二维码与随机密钥,手机扫码在同 Wi-Fi 下阅读与编辑。

️ 常用快捷键

快捷键 功能操作 快捷键 功能操作
Ctrl+O 打开 Markdown 文件 Ctrl+E 进入/退出编辑模式
Ctrl+S 保存当前文档(首存自动备份) Ctrl+P 打开导出面板 (PDF/Word/HTML)
Ctrl+F 全文搜索 (Enter 下一个 / Esc 退出) Ctrl+Shift+F 展开/收起目录大纲侧栏
Ctrl+Shift+A 呼出 AI 助手面板 Ctrl+U 打开网页转 MD 弹窗
Ctrl+D 切换主题 (浅色/暗色/复古) F11 / Esc 进入 / 退出 Zen 禅模式

架构与源码构建

readmd/
├─ rust/readmd-kernel/ # 100% 纯原生 Rust 高性能内核(HTTP 服务 + 自动修正 + 格式转换 + 矢量 PDF + 伴读桌宠)
│ └─ src/ # 原生平台适配 / OCR / 转换 / AI / 插件引擎
├─ ReadMD.exe # 原生高性能单文件可执行文件 (100% Pure Rust)
├─ packages/ # 多端生态分包
│ ├─ vscode-extension/ # VSCode 官方扩展
│ ├─ mcp-server/ # FastMCP (stdio) 服务端
│ ├─ harmonyos-app/ # HarmonyOS/OpenHarmony 实验性源码预览(未支持)
│ └─ linglong/ # 统信 UOS 玲珑容器打包配置
├─ scripts/ # 构建与打包脚本 (windows / linux / unix)
├─ assets/ # 前端渲染、主题 token 与 46 语种 i18n 资源
├─ docs/ # 架构规范、语言对照清单与开发文档
└─ tests/ # 自动化测试套件 (Rust 1,784 项单元测试 + 前端验收全通过)

本地构建与运行:

  • 使用 Cargo 编译:cargo build --release -p readmd-kernel,构建产物位于 rust/target/release/readmd.exe(根目录 ReadMD.exe 即为此纯原生二进制)。
  • Windows:运行 scripts\run.bat 直接启动原生内核;或直接双击 ReadMD.exe。
  • Linux:运行 cargo build --release -p readmd-kernel 后运行 bash scripts/linux/build_linux.sh 打包 AppImage 与 Deb 安装包。
  • macOS:运行 cargo build --release -p readmd-kernel 构建原生二进制。
  • HarmonyOS/OpenHarmony:本版本不支持,目录仅保留实验性源码预览。

更新日志 (v0.0.1-preview.1)

  • 46 语种全量母语化与机翻清洗:深入审核 42 个非中英文语言字典,消除波兰语混淆、西部之塔、农作物裁剪等全部系统性翻译错误,实现 100% 完整覆盖。
  • Linux 与信创国产系统适配:原生 Rust native_system 模块;正式支持只覆盖矩阵中有实机证据的 Ubuntu、Debian、UOS、银河麒麟和 Deepin 架构。
  • 离线来源与 Skills:上游原文、许可证和适配元数据随包提供,AI 指令统一从 Skills 加载。
  • LaTeX PRO 学术论文套件:零配置 .bib 参考文献浮动卡片、学术 Callout 盒子与 LaTeX 导出。
  • Editor Studio PRO 体验重塑:Zen 禅模式全屏专注、10×10 表格设计器、Excel 智能转换。
  • VSCode 插件与 MCP Server 生态完善:升级至 v0.0.1,提供多端 AI 写作协作流。

常见问题

  • Q: 为什么双击打开速度极快?
  • A: 安装版为 onedir 目录部署,启动无需临时解压;关闭后常驻系统托盘,二次打开通过轻量本地通信在 0.3s 内瞬间唤醒。
  • Q: 打开未签名安装包被系统拦截怎么办?
  • A: Windows 在 SmartScreen 提示点击「更多信息 → 仍要运行」;macOS 首次打开在 Finder 中右键 ReadMD.app 选择「打开」。请核对 SHA256SUMS.txt 校验码。
  • Q: 文档格式自动修正常见错误会改写我的原始文件吗?
  • A: 绝不会。自动修正仅发生在内存渲染阶段,原 .md 源码保持 100% 完好无损。

ReadMD · 纯本地优先,在已验收平台上自由阅读写作。

Releases

Recent versions

All releases ↗
  1. v2.3.9ReadMD v2.3.9
  2. v2.3.8ReadMD v2.3.8
  3. v2.3.7ReadMD v2.3.7
  4. v2.3.7-beta.5ReadMD v2.3.7-beta.5
  5. v2.3.7-beta.4ReadMD v2.3.7-beta.4
  6. v2.3.7-beta.3ReadMD v2.3.7-beta.3