dsh-obsidian-notes 0.5.2 → 0.6.1

package/README.md

@@ -7,34 +7,35 @@
 [![CI](https://github.com/revive123456/dsh-obsidian-notes/actions/workflows/ci.yml/badge.svg)](https://github.com/revive123456/dsh-obsidian-notes/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/revive123456/dsh-obsidian-notes/blob/main/LICENSE)
 ![DSH 0.2.1+](https://img.shields.io/badge/DSH-0.2.1%2B-blueviolet)
+[![dshbase verified](https://dshbase.com/badges/dsh-obsidian-notes.svg)](https://dshbase.com/zh/plugins/dsh-obsidian-notes/)
+[![GitHub stars](https://img.shields.io/github/stars/revive123456/dsh-obsidian-notes?style=flat)](https://github.com/revive123456/dsh-obsidian-notes/stargazers)
 
 English | [中文](https://github.com/revive123456/dsh-obsidian-notes/blob/main/README.zh.md)
 
 ---
 
-## Why this one
-
-There is already an Obsidian-ish plugin in the DSH ecosystem
-([DedsecLemon/dsh-obsidian](https://github.com/DedsecLemon/dsh-obsidian)), and it
-is a good fit if you want an outline pane, backlinks and `==highlight==`. This
-plugin bet on a different set of things — the three that matter if you write next
-to a chat:
-
-1. **Rendering fidelity is the feature.** The preview is line-numbered and keeps
-   the Obsidian details other viewers flatten: all 13 callout types plus 15
-   aliases, table alignment, fenced code with info strings, task lists, setext
-   headings, and frontmatter that round-trips byte-for-byte on save.
-2. **Pasted screenshots stay attached.** Paste an image while editing and the
-   host writes an Obsidian-native `![[Pasted image …]]` embed. Move the
-   attachment folder later and every embed in the vault is rewritten to match.
-3. **The note can talk to the chat.** Cite a whole note as an `@path` mention, or
-   select a passage and ask about it — the prompt carries the absolute path, the
-   line range and the quoted text.
-
-> **What it does not do:** no backlinks, no outline pane, no graph view, and no
-> math/mermaid/transclusion rendering. If those are your priority, use a real
-> Obsidian vault (or the plugin above) instead. The [comparison](#comparison) is
-> spelled out below.
+## What it does
+
+A local-first Markdown notes panel that sits in the DSH sidebar and hands notes
+to the chat without copy-paste:
+
+1. **Your notes stay beside the conversation.** Point it at a folder of Markdown
+   files and you get the vault tree, a line-numbered Obsidian-flavoured preview,
+   edit/save, and search across titles and bodies — no import, no sync, no cloud.
+2. **The handoff is the feature.** Cite a whole note as an `@path` mention, or
+   select a passage and press **Ask** — the prompt in the composer carries the
+   absolute path, the line range and the quoted text, so the model can refer to
+   exactly what you read.
+3. **Screenshots become part of the vault.** Paste an image while editing and it
+   is saved into the attachment folder as an Obsidian-native
+   `![[Pasted image …]]` embed; moving that folder later rewrites the embeds.
+4. **Two ways to see the shape of a vault.** Turn a note into a **mind map**
+   built from its headings and list items, or open the **relation graph**
+   computed from `[[links]]` and `#tags` — vault-wide, or locally around the open
+   note with 1–5 hops.
+
+Everything runs on your machine: the plugin reads and writes only the folder you
+choose, and the client talks to the host over its own loopback routes.
 
 ## Screenshots
 
@@ -46,6 +47,10 @@ to a chat:
 | --- | --- |
 | ![Table with column alignment and a TypeScript code fence](https://raw.githubusercontent.com/revive123456/dsh-obsidian-notes/main/docs/assets/screenshot-markdown.png) | ![Editor with line numbers and Save button](https://raw.githubusercontent.com/revive123456/dsh-obsidian-notes/main/docs/assets/screenshot-editing.png) |
 
+| Mind map from headings + lists | Vault-wide graph view (notes, links, tags) |
+| --- | --- |
+| ![Mind map view built from the note headings and list items](https://raw.githubusercontent.com/revive123456/dsh-obsidian-notes/main/docs/assets/screenshot-mindmap.png) | ![Relation graph of the whole vault: notes as circles, tags as squares, links as lines](https://raw.githubusercontent.com/revive123456/dsh-obsidian-notes/main/docs/assets/screenshot-graph.png) |
+
 ![Select a passage and ask about it: path, line numbers and quote are sent with the question](https://raw.githubusercontent.com/revive123456/dsh-obsidian-notes/main/docs/assets/screenshot-ask.png)
 
 ## Install
@@ -58,13 +63,23 @@ A plugin that ships a bundle layer is only composed at startup, so **restart the
 DSH host after installing** (desktop: quit and reopen). Refreshing the page is
 not enough.
 
+### Already installed? Upgrading
+
+Replacing the package and refreshing the page is enough for new UI features: the
+client asks the host which capabilities it has (`/obsidian/root` → `features`)
+and, when the running host is still the previous version, builds data it needs
+from the existing routes instead of erroring. The relation graph, for example,
+falls back to walking the vault with the old tree/note endpoints — no restart
+and no "version mismatch" dialog. Restart the host when you want the faster
+host-side route.
+
 ### 1. Desktop app (after the npm release)
 
 1. Open **Settings → Plugins**.
 2. Search for **`dsh-obsidian-notes`** and install it.
 3. Restart DeepSeek Harness.
 
-> This path requires the package to be published on npm (current release **0.5.2**).
+> This path requires the package to be published on npm.
 > If search shows nothing, use one of the two paths below.
 
 ### 2. CLI (after the npm release)
@@ -110,6 +125,18 @@ configured, choose one:
 The default vault is `$DSH_WORKSPACE/obsidian_vault`, falling back to
 `./obsidian_vault` under the directory you started `dsh web` from.
 
+### Typical workflow
+
+1. Open **📚 Notes** and pick a vault (above).
+2. Click a note to read the line-numbered preview; **Edit** to change it, then
+   **Save** or <kbd>Ctrl/Cmd+S</kbd>.
+3. To bring a note into the chat, press **⤴ Cite to chat** for the whole note, or
+   select text and press **Ask** to attach a question to that passage.
+4. Paste a screenshot while editing to store it in the vault.
+5. Switch the dock to **🧠 Mind map** to explore the note's structure, or open
+   **🕸 Graph view** above the tree to see the vault as a graph (**Local** = around
+   the open note, **Depth 1–5**).
+
 ## Features
 
 - **Vault sidebar** — lazy directory tree; open a note with one click, create,
@@ -118,7 +145,21 @@ The default vault is `$DSH_WORKSPACE/obsidian_vault`, falling back to
 - **Line-numbered Obsidian preview** — every source line keeps its line number.
   Real tables with alignment, fenced code with language labels, nested lists and
   task lists, all heading levels, setext headings, horizontal rules, and
-  clickable `[[wikilinks]]` (aliases and `#sections` included).
+  clickable `[[wikilinks]]` (aliases and `#sections` included). Inline Obsidian
+  styles render too: `==highlight==`, `~~strikethrough~~`, backslash escapes,
+  hidden `%%comments%%`, and `<https://…>` / bare URLs as links.
+- **Graph view** — a vault-wide relation graph built from every note's `[[links]]`
+  and `#tags` (no graph file, no export step: it is computed from your Markdown on
+  the fly, like Obsidian's own graph). A vault-level entry above the note tree
+  opens it as its own view; scroll to zoom, drag to pan, hover to highlight
+  neighbours, click a note to open it in the dock. **Local** shows the
+  neighbourhood of the note that is currently open; the depth is adjustable
+  from 1 to 5 hops (same range as Obsidian's local graph depth slider, default
+  1), and **Focus current note** jumps from the vault view straight to it.
+- **Mind map view** — toggle the preview into a horizontal mind map built from the
+  note's headings and list items. Scroll to zoom, drag to pan; select a node to
+  jump to its source line, or insert that whole branch (node + descendants) into
+  the chat as context. Rendering only — the Markdown file is untouched.
 - **Callouts** — `> [!type] title` blocks render with type colours, icons and
   badges. 13 canonical types (`note`, `abstract`, `info`, `todo`, `tip`,
   `success`, `question`, `warning`, `failure`, `danger`, `bug`, `example`,
@@ -153,26 +194,6 @@ The default vault is `$DSH_WORKSPACE/obsidian_vault`, falling back to
 The UI is bilingual (English / Chinese) and uses DSH theme tokens, so it follows
 the app's light and dark themes.
 
-## Comparison
-
-| | This plugin | [DedsecLemon/dsh-obsidian](https://github.com/DedsecLemon/dsh-obsidian) |
-| --- | --- | --- |
-| Vault tree, search | ✅ tree, title + body search | ✅ tree, whole-vault matching-line search |
-| Obsidian callouts | ✅ 13 types + 15 aliases, line-numbered spine | ✅ rendered, fold state kept |
-| Tables, fenced code, setext headings | ✅ | ✅ |
-| Frontmatter | ✅ preserved on save | ✅ shown as properties |
-| Paste screenshots + attachment folder moves | ✅ | — |
-| Cite a note / ask about a selection | ✅ | — |
-| Session & workspace housekeeping | ✅ | — |
-| Backlinks | ❌ | ✅ |
-| Outline pane | ❌ | ✅ |
-| `==highlight==` | ❌ | ✅ |
-
-The point is not "more features" — it is a different trade-off. If you need
-outline and backlinks, use the other plugin (or Obsidian itself); if you want a
-faithful Obsidian reading/editing experience with a clean hand-off into the chat,
-this one is built for that.
-
 ## Configuration
 
 Everything lives inside the notes pane; there is no YAML to edit.
@@ -246,10 +267,10 @@ Settings are persisted in `$DSH_HOME/dsh-obsidian-vault.json`
 - **Node.js:** `^22.19 || >=24` (needed only when running the host from source).
 - **OS:** paths are handled with the platform separator; session paths use
   `$DSH_HOME`. The screenshots above were captured on macOS.
-- **Not rendered** (kept as source text): math, mermaid, footnotes, strikethrough
-  and highlight, tags, raw HTML, note transclusion, audio/PDF embeds, block refs
-  (`^id`), callout folding/unknown types/nested callouts, and some inline
-  emphasis edge cases (`***bold italic***`, nested emphasis, `_` next to text).
+- **Not rendered** (kept as source text): math, mermaid, footnotes, tags, raw
+  HTML, note transclusion, audio/PDF embeds, block refs (`^id`), callout
+  folding/unknown types/nested callouts, and some inline emphasis edge cases
+  (`***bold italic***`, nested emphasis, `_` next to text).
 
 ## Development
 

package/README.zh.md

@@ -7,22 +7,23 @@
 [![CI](https://github.com/revive123456/dsh-obsidian-notes/actions/workflows/ci.yml/badge.svg)](https://github.com/revive123456/dsh-obsidian-notes/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/revive123456/dsh-obsidian-notes/blob/main/LICENSE)
 ![DSH 0.2.1+](https://img.shields.io/badge/DSH-0.2.1%2B-blueviolet)
+[![dshbase 实测可装](https://dshbase.com/badges/dsh-obsidian-notes.svg)](https://dshbase.com/zh/plugins/dsh-obsidian-notes/)
+[![GitHub stars](https://img.shields.io/github/stars/revive123456/dsh-obsidian-notes?style=flat)](https://github.com/revive123456/dsh-obsidian-notes/stargazers)
 
 [English](https://github.com/revive123456/dsh-obsidian-notes/blob/main/README.md) | 中文
 
 ---
 
-## 为什么是这一个
+## 它能做什么
 
-DSH 生态里已经有一个 Obsidian 方向的插件
-（[DedsecLemon/dsh-obsidian](https://github.com/DedsecLemon/dsh-obsidian)），
-它适合需要大纲、反链和高亮的人。本插件押的是另外三件事 —— 如果你习惯「一边写笔记、一边和模型讨论」，这三件更重要：
+一个本地优先的 Markdown 笔记面板：在 DSH 侧边栏里读笔记，并把笔记顺手递进对话，不用复制粘贴。
 
-1. **渲染细节本身就是功能。** 预览带行号，并保留 Obsidian 的渲染细节：13 种 callout 类型 + 15 个别名、表格对齐、带语言标签的围栏代码、任务列表、setext 标题；frontmatter 不进编辑器，保存时按原文拼回。
-2. **粘贴的截图不会丢。** 编辑时粘贴图片，host 落盘为 Obsidian 原生引用 `![[Pasted image …]]`；以后迁移附件目录，全库笔记里的引用会一并改写。
-3. **笔记能接进对话。** 整篇引用为 `@绝对路径`；选中一段再提问，注入的内容带文件路径、行号区间和原文。
+1. **笔记就在对话旁边。** 指向一个 Markdown 文件夹，就有目录树、带行号的 Obsidian 风格预览、编辑保存，以及标题和正文搜索——不导入、不同步、不上云。
+2. **「递进对话」本身就是功能。** 整篇引用为 `@绝对路径`；选中一段点 **Ask**，输入框里的 prompt 带着绝对路径、行号区间和原文，模型能准确引用你正在看的这一段。
+3. **截图直接进笔记库。** 编辑时粘贴图片会存进附件目录，并写成 Obsidian 原生的 `![[Pasted image …]]`；以后迁移附件目录，全库引用会一起改写。
+4. **两种看结构的方式。** 把笔记切换成由标题和列表生成的**思维导图**；或打开由 `[[双链]]` 和 `#标签` 现算的**关系图谱**——全库视角，或聚焦当前笔记的 1–5 跳局部视角。
 
-> **它不做什么：** 没有反链、没有大纲面板、没有关系图，也不渲染数学公式 / mermaid / transclusion。这些是你的刚需就用真 Obsidian（或上面那个插件）。对比在[下方](#对比)写清楚。
+全部在本机运行：插件只读写你选择的文件夹，客户端只走宿主自己的 loopback 路由。
 
 ## 截图
 
@@ -34,6 +35,10 @@ DSH 生态里已经有一个 Obsidian 方向的插件
 | --- | --- |
 | ![带列对齐的表格与 TypeScript 代码块](https://raw.githubusercontent.com/revive123456/dsh-obsidian-notes/main/docs/assets/screenshot-markdown.png) | ![带行号的编辑器与保存按钮](https://raw.githubusercontent.com/revive123456/dsh-obsidian-notes/main/docs/assets/screenshot-editing.png) |
 
+| 由标题 + 列表生成的思维导图 | 全库关系图谱（笔记、双链、标签） |
+| --- | --- |
+| ![由笔记标题与列表生成的思维导图](https://raw.githubusercontent.com/revive123456/dsh-obsidian-notes/main/docs/assets/screenshot-mindmap.png) | ![全库关系图谱：圆圈是笔记、方块是标签、线是双链/标签关系](https://raw.githubusercontent.com/revive123456/dsh-obsidian-notes/main/docs/assets/screenshot-graph.png) |
+
 ![选中一段文字提问：路径、行号与原文会随问题一起注入](https://raw.githubusercontent.com/revive123456/dsh-obsidian-notes/main/docs/assets/screenshot-ask.png)
 
 ## 安装
@@ -42,13 +47,17 @@ DSH 生态里已经有一个 Obsidian 方向的插件
 
 带 bundle 的插件只在启动时装配，所以**安装后必须重启 DSH host**（桌面版：退出再打开）。只刷新页面不够。
 
+### 已经装过？升级说明
+
+换掉包、刷新页面就能用上新界面能力：客户端会先问 host 支持哪些能力（`/obsidian/root` → `features`），如果运行中的 host 还是旧版，就用**已有接口在浏览器里自建**需要的数据，而不是弹「版本不匹配」错误。比如关系图谱在旧 host 上会回退成用旧的 tree/note 接口遍历 vault 构建——不用重启、也不会看到报错。想要更快的 host 侧路径时再重启一次即可。
+
 ### 1. 桌面版（npm 发布后）
 
 1. 打开 **Settings → Plugins**；
 2. 搜索 **`dsh-obsidian-notes`** 并安装；
 3. 重启 DeepSeek Harness。
 
-> 这条路径要求 npm 上已有该包（当前版本 **0.5.2**）。搜不到时用下面两种方式。
+> 这条路径要求 npm 上已有该包。搜不到时用下面两种方式。
 
 ### 2. CLI（npm 发布后）
 
@@ -89,10 +98,20 @@ dsh plugin --profile web add "$(pwd)"            # PowerShell 用 "$PWD"
 默认 Vault 为 `$DSH_WORKSPACE/obsidian_vault`，缺省回落到启动 `dsh web` 目录下的
 `./obsidian_vault`。
 
+### 典型用法
+
+1. 打开 **📚 笔记**，先选一个 Vault（见上）。
+2. 点击笔记读带行号的预览；点 **编辑** 修改，再点 **保存** 或 <kbd>Ctrl/Cmd+S</kbd>。
+3. 把笔记带进对话：整篇点 **⤴ 引用到对话**；选中一段点 **Ask**，把问题附着在那段文字上。
+4. 编辑时粘贴截图，会存进 Vault 的附件目录。
+5. 把 Dock 切成 **🧠 思维导图** 看笔记结构；或点笔记树上方的 **🕸 关系图谱** 看全库图（**局部** = 当前笔记周围，**跳数 1–5**）。
+
 ## 功能
 
 - **Vault 侧边栏**：按需加载的目录树；单击打开笔记，新建 / 重命名 / 删除笔记与文件夹，按标题**和正文**搜索，显示笔记数徽标。
-- **带行号的 Obsidian 预览**：一行源码对应一行渲染并带行号。真表格（支持 `:---` / `:---:` / `---:` 对齐）、带语言标签的围栏代码、嵌套列表与任务列表、`#`～`######` 标题、setext 标题、分隔线、可点击的 `[[双链]]`（含别名与 `#章节`）。
+- **带行号的 Obsidian 预览**：一行源码对应一行渲染并带行号。真表格（支持 `:---` / `:---:` / `---:` 对齐）、带语言标签的围栏代码、嵌套列表与任务列表、`#`～`######` 标题、setext 标题、分隔线、可点击的 `[[双链]]`（含别名与 `#章节`）；行内也支持 `==高亮==`、`~~删除线~~`、反斜杠转义、隐藏的 `%%注释%%`，以及 `<https://…>` / 裸 URL 自动成链。
+- **关系图谱**：全库关系图，节点/连线直接由每篇笔记的 `[[双链]]` 与 `#标签` 现算（没有额外图谱文件，也不导出——和 Obsidian 自己的图谱一样从 Markdown 推导）。入口在笔记树上方的 vault 级「🕸 关系图谱」行，点击后在独立视图里显示；滚轮缩放、拖动平移、悬停高亮邻居、点笔记节点在 Dock 里打开。切到「局部」可看当前打开笔记的邻居，跳数可在 1–5 之间调（与 Obsidian 局部图谱的 depth 范围一致，默认 1）；「聚焦当前笔记」可从全库一键切到该视角。
+- **思维导图视图**：把预览切换成由标题 + 列表生成的横向思维导图。滚轮缩放、拖动平移；选中节点可跳到对应源码行，或把「该分支（节点 + 全部后代）」作为上下文插入对话。纯渲染，不改动 Markdown 文件。
 - **Callout**：`> [!type] 标题` 按类型渲染颜色、图标与徽标。13 种规范类型（`note`、`abstract`、`info`、`todo`、`tip`、`success`、`question`、`warning`、`failure`、`danger`、`bug`、`example`、`quote`）+ 15 个 Obsidian 别名（`summary`、`tldr`、`hint`、`important`、`check`、`done`、`help`、`faq`、`caution`、`attention`、`fail`、`missing`、`error`、`cite`、`none`）。
 - **编辑与保存**：带行号的源码编辑器，点 `保存` 或按 <kbd>Ctrl/Cmd+S</kbd>。YAML frontmatter 不进编辑器，保存时原样拼回；外部对 YAML 的改动不会被覆盖。
 - **粘贴截图**：编辑时 <kbd>Ctrl/Cmd+V</kbd> 把剪贴板图片写入附件目录，并在光标处插入 Obsidian 原生写法 `![[Pasted image <时间戳>.png]]`（单张上限 20 MB），写进 `.md` 的内容可被真实 Obsidian 识别。
@@ -103,23 +122,6 @@ dsh plugin --profile web add "$(pwd)"            # PowerShell 用 "$PWD"
 
 界面中英双语，使用 DSH 主题变量，跟随应用的浅色 / 深色主题。
 
-## 对比
-
-| | 本插件 | [DedsecLemon/dsh-obsidian](https://github.com/DedsecLemon/dsh-obsidian) |
-| --- | --- | --- |
-| Vault 目录树、搜索 | ✅ 目录树 + 标题/正文搜索 | ✅ 目录树 + 全库命中行搜索 |
-| Obsidian callout | ✅ 13 种类型 + 15 别名，逐行渲染 | ✅ 渲染，保留折叠状态 |
-| 表格、围栏代码、setext 标题 | ✅ | ✅ |
-| frontmatter | ✅ 保存时原样拼回 | ✅ 以属性区展示 |
-| 粘贴截图 + 附件目录迁移 | ✅ | — |
-| 整篇引用 / 选中片段提问 | ✅ | — |
-| 会话与工作区整理 | ✅ | — |
-| 反链 | ❌ | ✅ |
-| 大纲面板 | ❌ | ✅ |
-| `==高亮==` | ❌ | ✅ |
-
-比的不是「功能多少」，而是取舍：需要大纲和反链，用另一个插件（或真 Obsidian）；想要忠实的 Obsidian 阅读/编辑体验、并顺手把笔记递进对话，这个插件就是为此写的。
-
 ## 配置
 
 所有配置都在笔记面板里完成，不用手改 YAML。
@@ -165,7 +167,7 @@ dsh plugin --profile web add "$(pwd)"            # PowerShell 用 "$PWD"
 - **DSH：** 已对照 **0.2.1-rc.5** 验证（Web UI、桌面版外壳）。composer 集成面向 DSH 0.2 的 Lexical 输入框，并保留 0.1.x textarea 的降级路径。
 - **Node.js：** `^22.19 || >=24`（仅从源码运行 host 时需要）。
 - **系统：** 路径按平台分隔符处理，会话路径基于 `$DSH_HOME`。上面的截图在 macOS 上录制。
-- **不渲染（保持原文显示）**：数学公式、mermaid、脚注、删除线/高亮、标签、裸 HTML、笔记 transclusion、音频/PDF 嵌入、块引用 `^id`、callout 折叠/未知类型/嵌套，以及部分行内强调边界（`***粗斜体***`、嵌套强调、`_` 相邻文本）。
+- **不渲染（保持原文显示）**：数学公式、mermaid、脚注、标签、裸 HTML、笔记 transclusion、音频/PDF 嵌入、块引用 `^id`、callout 折叠/未知类型/嵌套，以及部分行内强调边界（`***粗斜体***`、嵌套强调、`_` 相邻文本）。
 
 ## 开发