Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 3.3 KB

File metadata and controls

63 lines (40 loc) · 3.3 KB

Markdown Reader 宣传文案

中文 | English

一句话

Markdown Reader 是一个不用打开 IDE 的本地项目 Markdown 文档库,把 PRD、README、技术方案、会议记录和排障笔记整理成可搜索、可收藏、可导出的资料库。

推荐标题

  • 我做了一个不用打开 IDE 的本地 Markdown 项目文档阅读器
  • 把项目里的 PRD、README、排障记录变成本地资料库
  • 给经常翻项目文档的人做了一个 Tauri 桌面小工具
  • 不是 Markdown 编辑器,是本地项目文档检索工作台

短文案

如果你的项目资料都散在 Markdown 文件里,但又不想每次打开 IDE 找文档,Markdown Reader 可以把一个目录直接变成本地文档库。

它支持全文搜索、目录跳转、阅读位置恢复、收藏和置顶,也能做轻量编辑、本地图片插入,并导出 Word、PDF、纯文本和阅读 HTML。所有文件默认留在本地,渲染经过安全净化,桌面端文件操作也限制在已打开的 Markdown 工作区内。

适合管理项目 README、PRD、技术方案、会议记录、排障记录和个人知识库。

它不想替代 Typora、Obsidian 或 VS Code。它的定位更窄:当你只是想快速打开一个项目目录,搜索、阅读、收藏和导出里面的 Markdown 文档时,不需要先进入完整开发环境。

社区短帖

我做了一个本地优先的 Markdown 项目文档阅读器:Markdown Reader。

它不是另一个 Markdown 编辑器,而是给项目文档用的本地资料库。打开一个目录,就能搜索 PRD、README、技术方案、会议记录和排障笔记;支持大纲跳转、阅读位置恢复、收藏、置顶、轻量编辑,以及 Word/PDF/HTML 导出。

技术栈是 Tauri + React + TypeScript,目前已经有 Windows 和 macOS Apple Silicon / M 系列安装包。

GitHub: https://github.com/honestTai/tauri-markdown-reader

亮点

  • 本地优先:打开目录或单个 .md 文件即可阅读,不依赖云端。
  • 资料库视图:按目录、收藏、置顶、最近文件和更新时间整理 Markdown。
  • 全文搜索:覆盖文件名、标题、frontmatter、正文和片段预览。
  • 阅读体验:三栏工作台、右侧大纲、字数统计、图片状态检查和阅读位置恢复。
  • 轻编辑:支持保存前备份、本地图片插入和源码编辑。
  • 多格式导出:Word、PDF、Markdown、纯文本、阅读 HTML。
  • 安全加固:DOMPurify 渲染净化、严格 Tauri CSP、工作区范围内文件访问、CI 自动检查。
  • 最新文档:README 已支持中文 / English 切换,便于国内外用户快速了解项目。

差异化定位

  • 不是写作编辑器:重点是阅读、检索和复用已有项目文档。
  • 不是云端笔记:默认本地优先,不要求同步账号。
  • 不是 IDE 插件:适合不进入开发环境时快速查文档。
  • 不是大型知识库系统:打开目录即可用,轻量、直接、面向日常项目资料。

可配图素材

  • 运行 GIF:docs/assets/markdown-reader-demo.gif
  • 中文截图:docs/assets/markdown-reader-zh.png
  • 英文截图:docs/assets/markdown-reader-en.png

发布链接