vsidian-codex-bridge
把 Codex(OpenAI 的编程助手)的两样东西带进 Vsidian(VSCode 里类 Obsidian 的 Markdown 编辑器):从 Codex 复制的链接粘贴进笔记仍是链接,Mermaid 图可以渲染成 Codex 的样式。粘贴还原装好即生效,主题在设置里手动选择;停用或卸载组件,Vsidian 一切照旧。
粘贴 Codex 内容,链接还是链接
从 Codex 聊天复制内容粘贴到 Vsidian,链接会被转成带转义符的字面文本,渲染后无法点击。装上本组件后,粘贴时自动还原为标准 Markdown 链接。
|
粘贴进笔记的结果 |
| 不装组件 |
\[修复清单\](https://github.com/ONEGAYI/vsidian-codex-bridge/blob/HEAD/notes/fixes.md)——字面文本,渲染后点不了 |
| 装上组件 |
[修复清单](https://github.com/ONEGAYI/vsidian-codex-bridge/blob/HEAD/notes/fixes.md)——标准链接,渲染后可点击 |
还原发生在粘贴这一步,已经写进笔记的内容不会被二次改动。
Mermaid 图的 Codex 主题
Vsidian 的「设置 → 外观 → 主题」下拉里会多出一个 Codex 候选。安装只新增候选,不自动切换;选择之后,笔记里的 Mermaid 图按 Codex 配色渲染:
- 亮色画布纯白(
#ffffff)、暗色画布深灰(#181818),跟随编辑器明暗自动切换——内置 default 主题没有这层暗色填充
- 流程图使用 ELK 布局、圆角矩形
- 覆盖流程图、时序图、类图、状态图、ER 图、甘特图、饼图;mindmap、时间线等其他图型仍按默认样式渲染
- 渲染引擎 mermaid 11.12.2 由组件自带打包,不联网加载
安装
前置:VSCode 1.82.3 或更新,Vsidian 1.1.0 或更新(未装 Vsidian 时组件不激活,也没有副作用)。
两个渠道任选其一:
- VSCode Marketplace:扩展面板搜索
Vsidian Codex Bridge 安装,或命令行执行:
code --install-extension ONEGAYI.vsidian-codex-bridge
- GitHub Release:从 Releases 下载 VSIX,扩展面板「… → 从 VSIX 安装…」选择下载的文件。
安装后按提示重载窗口即生效。想确认装好了,可以做两件事:
- 从 Codex 聊天复制一段带链接的内容,粘贴到 Vsidian 笔记,链接应当可以点击;
- 「外观 → 主题」选择 Codex,打开一篇含 Mermaid 图的笔记并切到暗色模式,画布应当是深灰底色。
升级、停用与卸载
- Marketplace 安装的组件随发布自动更新;VSIX 渠道下载新版 VSIX 覆盖安装即可。各版本变化见 CHANGELOG。
- 停用或卸载组件,Vsidian 完全可用:粘贴回落内置转换,Mermaid 回落内置 default 主题。已选的 Codex 主题设置保留,组件恢复后自动回到 Codex 渲染。
版本兼容
| 组件版本 |
需要 Vsidian |
说明 |
| 0.1.0 |
≥ 1.1.0 |
首个版本,随 Vsidian 附加组件 API 1.1.0 发布 |
开发
npm install # 安装 devDependencies(无运行时依赖)
npm run compile # 构建三产物(宿主 / 页面 / mermaid 分块)+ 类型检查
npm test # 构建后运行 vitest 单元层
npm run vendor:check # 校验 SDK 类型快照无漂移
npm run package # 本地 VSIX 打包(含内容与体积红线检查)
npm run test:host # 宿主层静默验证(需 --host 指向 vsidian 构建产物仓)
node test/browser/smoke-mermaid.mjs # 浏览器层冒烟(需 vsidian 主仓的 Playwright)
架构决策见 docs/adr/,开发规范与任务台账见 AGENTS.md,发布流程见 ADR-0004。
License
MIT
| |