ReadFlow

unlisted

by Ohyep

MDX 转换、图片本地化、多标签 AI 对话、双 AI 对比分析

★ 1 starsUpdated 3mo agoMIT
View on GitHub

ReadFlow — Obsidian 阅读笔记插件

一体化阅读笔记工作流:MDX 格式转换 · 图片本地化 · 多标签 AI 对话 · 双模型对比分析

English summary: ReadFlow is an Obsidian plugin for reading workflows. It converts MDX/JSX components (Tip, Note, Callout, Steps, Tabs, etc.) into native Obsidian Markdown, localizes external images into your attachment folder, and provides an in-panel AI chat that can analyze the current note together with its linked references. It supports multiple chat tabs and a dual-model compare mode.


功能特性

MDX 转换 把从 Mintlify、Docusaurus、Nextra 等文档站复制来的 MDX/JSX 内容转换成 Obsidian 能正确渲染的 Markdown:

  • <Tip> <Note> <Warning> <Info> <Check> <Danger> <Callout> → 原生 Callout
  • <Steps> / <Step title="..."> → 带加粗序号的步骤小节(保留步骤内的代码块)
  • <Tabs> / <Tab> → 小节标题
  • <img> <a> → Markdown 图片 / 链接
  • 其余未识别的组件标签去壳保留内容,不会丢正文

转换前会先保护代码块和行内代码,避免缩进错乱破坏围栏。转换记录写入 vault 根目录的 _conversion-log.md。

图片本地化 一键把当前笔记里的外链图片(https://...)下载到 Obsidian 设置的附件文件夹,并替换为本地引用。扩展名优先按响应的 Content-Type 推断。下载失败的图片保留原外链。

AI 对话与笔记分析 右侧面板提供 AI 对话。点「分析当前文件」时,插件会读取当前笔记,并抓取其中的双向链接与外部链接内容(最多两层、每层数量可配),连同正文一起发给模型分析。聊天区只显示一条简短提示,完整内容在后台发送,不污染对话窗口。

多标签对话 支持多个对话标签页(数量可配),每个标签独立保存历史。可新建标签、开启新对话、查看历史记录。

双模型对比 对比模式下,同一个问题同时发给模型 A 和模型 B,并排显示两份回答。可「采用 A」「采用 B」或「综合」——综合会把两份回答交给模型 A 融合成最终答案。模型 B 的 Key / URL / 模型名留空时自动复用模型 A 的配置,适合同一服务商不同模型的对比。


安装

暂未上架 Obsidian 社区插件市场,请手动安装。

  1. 前往 Releases 下载最新版,解压得到 main.js、manifest.json、styles.css
  2. 打开你的 Vault 目录下的 .obsidian/plugins/,新建文件夹 readflow
  3. 把上述三个文件放进 readflow 文件夹
  4. 在 Obsidian 中:设置 → 第三方插件 → 关闭安全模式 → 刷新已安装插件列表 → 启用 ReadFlow

使用

点击左侧边栏的图标打开 ReadFlow 面板。面板底部工具栏从左到右依次是:

图标功能说明
转换MDX 转换对当前文件执行 MDX → Markdown 转换
下载图片本地化下载当前文件所有外链图片到附件文件夹
扫描分析当前文件AI 分析笔记内容及其引用的链接(最多两层)
分栏对比模式开启 / 关闭双模型并排对比
退出退出对比仅在对比模式下显示
下拉模型选择切换当前使用的模型
发送发送发送输入框内容;Enter 发送,Shift+Enter 换行

面板上方一行:左侧是对话标签页(数字标识,悬停显示关闭按钮),右侧是新建标签、开启新对话、历史记录三个按钮。

粘贴含 MDX 组件的内容时会自动转换(可在设置中关闭)。


设置项

模型 A(主)

项目说明
API KeyOpenAI 或兼容接口的密钥
API URL接口地址。可只填域名(如 https://api.openai.com),会自动补全为 /v1/chat/completions
默认模型如 gpt-4o
可选模型列表英文逗号分隔,出现在输入框上方的模型下拉中

模型 B(对比模式)

项目说明
API Key留空则复用模型 A 的 Key
API URL留空则与 A 相同
模型留空则与 A 相同

行为

项目说明
系统提示词AI 对话使用的 system prompt
最大标签页数1–10
每层最多抓取链接数分析时每层读取的链接数量,1–10
粘贴时自动转换 MDX开关

兼容性

  • 需要 OpenAI 兼容的 Chat Completions 接口
  • 桌面端插件(isDesktopOnly: true)
  • 最低 Obsidian 版本:0.15.0

License

MIT

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.