docs(vault): add feature walkthroughs and sync local notes

2026-09-06 02:26:15 +08:00
parent 7001794a22
commit 9e0715f9db
10 changed files with 447 additions and 6 deletions
@@ -2,7 +2,6 @@
 title: RAG 检索增强与引用定位
 tags: RAG, 产品
 ---
-
 # RAG 概述

 检索增强生成先检索相关文档块，再交给大模型生成回答。
@@ -16,3 +15,4 @@ tags: RAG, 产品
 ## Reranker 精排

 粗排后使用 Reranker 对候选块重新打分，提升相关性。
+
@@ -0,0 +1,36 @@
+---
+title: mermaid格式测试
+tags: 产品, mermaid
+---
+
+<br />
+
+```mermaid
+graph TD
+    A[开始] --> B[用户输入账号密码]
+    B --> C{系统验证}
+    C -- 验证通过 --> D[跳转至首页]
+    C -- 验证失败 --> E[提示错误信息]
+    E --> B
+    D --> F[结束]
+    
+    style A fill:#f9f,stroke:#333,stroke-width:2px
+    style D fill:#9f6,stroke:#333,stroke-width:2px
+    style E fill:#f66,stroke:#333,stroke-width:2px
+```
+
+```mermaid
+sequenceDiagram
+    participant 用户 as 用户(浏览器)
+    participant 前端 as Vue/React 前端
+    participant 后端 as Java/Go 后端
+    participant DB as 数据库
+
+    用户 ->> 前端: 点击“获取数据”按钮
+    前端 ->> 后端: 发送 GET /api/data 请求
+    后端 ->> DB: 执行 SQL 查询
+    DB -->> 后端: 返回查询结果集
+    后端 -->> 前端: 返回 JSON 数据
+    前端 -->> 用户: 渲染并展示数据列表
+```
+
@@ -0,0 +1,37 @@
+---
+title: 功能演示导航
+tags: 演示, 入门
+---
+
+# 功能演示导航
+
+这组笔记用于在真实工作区查看 Markdown、代码高亮、图表和检索效果。文中的项目、日期和数据均为演示内容。
+
+## 建议阅读顺序
+
+| 笔记 | 可以查看的功能 |
+| --- | --- |
+| 01 Markdown 与大纲 | 元数据、标题层级、列表、引用、表格与行内代码 |
+| 02 多语言代码与公式 | Shiki 语言配色、代码块标签、数学公式 |
+| 03 Mermaid 图表集 | 六种常用图型、主题颜色和大图查看 |
+| 04 星灯项目资料 | 全文搜索、知识库问答与引用定位 |
+| 05 Skill 与 Plugin 操作样例 | 扩展安装、选区命令和只读笔记检查 |
+
+## 工作区操作
+
+1. 在文件树打开一篇演示笔记。
+2. 切换顶部“文件 / 大纲”，查看标题层级与跳转。
+3. 拖动侧栏边缘，观察正文随可用宽度变化。
+4. 在主题页选择不同主题，再回到笔记查看配色。
+5. 编辑后保存，刷新页面确认内容仍然存在。
+
+## 手动体验清单
+
+- [ ] 添加一个标签，再删除它。
+- [ ] 在正文键入一段行内代码。
+- [ ] 将一个代码块切换为另一种语言。
+- [ ] 打开 Mermaid 大图并缓慢滚轮缩放。
+- [ ] 搜索“星灯资料站”，打开结果并定位原文。
+- [ ] 在已配置模型后进行一次带知识库检索的问答。
+
+> 上述清单供体验时自行勾选，不是自动验收结果。模型调用可能产生费用，图表与代码示例本身不会执行代码。
@@ -0,0 +1,61 @@
+---
+title: Markdown 与大纲演示
+tags: 演示, Markdown, 编辑器
+---
+
+# Markdown 与大纲
+
+普通正文可以包含 **重点内容**、*强调内容*、~~已经废弃的说法~~，以及行内代码 `notes.search`。
+
+## 列表与引用
+
+1. 新建一篇笔记。
+2. 输入标题和正文。
+3. 保存后使用搜索查找它。
+
+- 文件夹用于组织主题。
+- 标签用于跨文件夹分类。
+  - 同一篇笔记可以拥有多个标签。
+  - 本文包含“演示”和“编辑器”标签。
+
+> 一条清晰的笔记应该能说明问题、保留依据，并在以后被找到。
+>
+> 引用块中的内容仍是笔记正文，不会自动成为 AI 的系统提示词。
+
+## 标题层级
+
+### 第三级：准备资料
+
+这里是 H3。打开“大纲”面板，观察字号、粗细与缩进。
+
+#### 第四级：整理来源
+
+将待整理的资料名称写在这里。
+
+##### 第五级：补充细节
+
+这一节用于检查深层标题的展开与收起。
+
+###### 第六级：最小标题
+
+再点击较高层标题，确认正文能够跳转到对应位置。
+
+## 表格和待办
+
+| 项目 | 状态 | 说明 |
+| :--- | :---: | ---: |
+| 写下问题 | 已整理 | 1 条 |
+| 补充证据 | 待整理 | 3 条 |
+| 形成结论 | 待整理 | 1 条 |
+
+- [x] 本文已经包含六级标题示例。
+- [ ] 自己添加一段引用。
+- [ ] 自己添加一行表格。
+
+---
+
+## 行内代码输入练习
+
+现成的行内代码：`const title = "我的笔记"`。
+
+可以在下一段先输入两个反引号，再把光标移到中间填入内容，观察写作模式是否识别为行内代码；也可以逐个输入完整的反引号与文本。
@@ -0,0 +1,89 @@
+---
+title: 多语言代码与公式
+tags: 演示, 代码, 数学
+---
+
+# 多语言代码与公式
+
+代码块用于展示源码，不会在工作区自动执行。切换明暗主题时，可以观察关键字、字符串和注释的配色。
+
+## Python：安全计算平均值
+
+```python
+def average(scores: list[float]) -> float | None:
+    """空列表没有平均值。"""
+    if not scores:
+        return None
+    return sum(scores) / len(scores)
+
+print(average([72, 86, 94]))
+```
+
+## TypeScript：整理标签
+
+```typescript
+interface Note {
+  title: string
+  tags: string[]
+}
+
+const note: Note = {
+  title: '星灯资料站',
+  tags: ['演示', '项目', '演示'],
+}
+const uniqueTags = [...new Set(note.tags)]
+console.log(uniqueTags)
+```
+
+## Rust：只读文本处理
+
+```rust
+fn main() {
+    let title = "星灯资料站";
+    let count = title.chars().count();
+    println!("标题包含 {count} 个字符");
+}
+```
+
+## SQL：演示查询
+
+下面是虚构表结构的查询示例，不表示应用数据库的实际表名。
+
+```sql
+SELECT title, updated_at
+FROM demo_notes
+WHERE category = '演示'
+ORDER BY updated_at DESC;
+```
+
+## JSON 与 YAML
+
+```json
+{
+  "project": "星灯资料站",
+  "offlineFirst": true,
+  "reviewDays": 7
+}
+```
+
+```yaml
+project: 星灯资料站
+milestones:
+  - 收集资料
+  - 完成校对
+  - 整理索引
+```
+
+## 数学公式
+
+行内公式：当 $n > 0$ 时，均值为 $\bar{x}=\frac{1}{n}\sum_{i=1}^{n}x_i$。
+
+块级公式：
+
+$$
+\operatorname{cos}(\mathbf{a},\mathbf{b})
+=\frac{\mathbf{a}\cdot\mathbf{b}}
+{\lVert\mathbf{a}\rVert\lVert\mathbf{b}\rVert}
+$$
+
+两个向量都非零时，上式表示余弦相似度。本文只演示公式显示，不执行向量检索。
@@ -0,0 +1,90 @@
+---
+title: Mermaid 六种图表演示
+tags: 演示, Mermaid, 可视化
+---
+
+# Mermaid 图表集
+
+以下图表没有指定节点颜色，便于查看默认配色如何跟随主题。把鼠标移到预览区域可查看缩放工具，并进入大图查看。
+
+## 流程图：资料整理
+
+```mermaid
+flowchart TD
+    A[收集资料] --> B{内容是否完整}
+    B -->|是| C[整理笔记]
+    B -->|否| D[补充来源]
+    D --> B
+    C --> E[保存并检索]
+```
+
+## 时序图：打开笔记
+
+```mermaid
+sequenceDiagram
+    participant U as 用户
+    participant W as 工作区
+    participant S as 本地服务
+    U->>W: 选择文件
+    W->>S: 请求笔记内容
+    S-->>W: 返回 Markdown
+    W-->>U: 显示正文与大纲
+```
+
+## 类图：演示数据关系
+
+```mermaid
+classDiagram
+    class Notebook {
+        +String name
+    }
+    class Note {
+        +String title
+        +String content
+    }
+    Notebook "1" --> "many" Note : contains
+```
+
+## 状态图：一份草稿
+
+```mermaid
+stateDiagram-v2
+    [*] --> Draft
+    Draft --> Reviewing: 提交校对
+    Reviewing --> Draft: 补充内容
+    Reviewing --> Complete: 校对完成
+    Complete --> [*]
+```
+
+## ER 图：虚构资料目录
+
+```mermaid
+erDiagram
+    NOTEBOOK ||--o{ NOTE : contains
+    NOTE ||--o{ SOURCE : references
+    NOTEBOOK {
+        string name
+    }
+    NOTE {
+        string title
+    }
+    SOURCE {
+        string label
+    }
+```
+
+## 甘特图：演示排期
+
+```mermaid
+gantt
+    title 资料整理演示排期
+    dateFormat YYYY-MM-DD
+    section 准备
+    收集资料 :a, 2026-09-07, 2d
+    section 整理
+    编写笔记 :b, after a, 3d
+    section 校对
+    检查来源 :c, after b, 1d
+```
+
+这些日期仅用于显示图表，不会创建真实任务或提醒。
@@ -0,0 +1,40 @@
+---
+title: 星灯资料站项目简报
+tags: 演示, 星灯项目, 检索
+---
+
+# 星灯资料站
+
+星灯资料站是本组演示中的虚构项目，目标是为一个读书小组建立离线可用的学习资料目录。项目代号为 ST-27。
+
+## 范围
+
+第一批资料包含 12 篇读书笔记、8 份讨论提纲和 4 份术语表，共 24 份文档。第一批不包含录音和视频。
+
+资料分为“入门阅读”“专题讨论”“术语速查”三个目录。每份文档至少包含标题、两个标签和一段内容摘要。
+
+## 时间安排
+
+资料收集截止日为 2026 年 9 月 10 日；校对截止日为 9 月 13 日；演示展示安排在 9 月 15 日。
+
+## 校对约定
+
+检查顺序为：标题与标签、正文完整性、引用来源、重复内容。引用缺少来源时，标记为“待补充”，不把推测写成原文结论。
+
+## 独特检索词
+
+本项目的检索口令是“蓝鹭书签”。它只用于演示搜索定位，不是密码或访问凭据。
+
+## 可尝试的问题
+
+配置并启用模型后，在 AI 对话中开启知识库检索，可以询问：
+
+- 星灯资料站第一批一共有多少份文档？分别是什么类型？
+- ST-27 的资料收集和校对截止日期是什么？
+- 找到提到“蓝鹭书签”的段落。
+- 第一批资料是否包含视频？请给出笔记依据。
+- 星灯资料站的负责人是谁？
+
+最后一个问题在本笔记中没有答案。检查回答是否说明资料不足，而不是编造负责人。其他问题可以对照正文并点击引用定位核实。
+
+> 新建笔记需要完成索引后才能参与检索。没有模型配置时，也可以先在搜索页使用项目名、代号或独特检索词查找原文。
@@ -0,0 +1,53 @@
+---
+title: Skill 与 Plugin 操作样例
+tags: 演示, Skill, Plugin
+---
+
+# Skill 与 Plugin 操作样例
+
+本页提供可选中的测试文本和操作步骤。写下扩展 ID 不会自动安装或启用扩展。
+
+## 内置 Plugin：选区命令
+
+确认 `text-tools` 已启用，选中下一行英文，然后打开编辑器右键菜单或工作区“扩展命令”工具栏，选择“转为大写”。
+
+hello notes agent
+
+预期收到大写文本通知 `HELLO NOTES AGENT`。此命令显示处理结果，不会自动替换笔记正文。
+
+没有选区时，依赖 `editor.has_selection` 的命令不应出现。停用对应 Plugin 后，该命令也不应继续执行。
+
+## 社区准备包：Markdown 检查
+
+仓库内提供 `markdown-workbench` Plugin 和依赖它的 `note-reviewer` Skill。先导入并启用 Plugin，再导入和启用 Skill；缺少依赖时应查看管理页提示。
+
+可以选中下面代码块中的纯文本内容，再运行 Markdown 检查命令。代码块中的标题是检查输入，不属于本页的大纲。
+
+```markdown
+# 资料整理
+
+### 跳级标题
+
+- [ ] 补充资料来源
+- [x] 整理已有术语
+
+### 跳级标题
+
+这里故意重复标题，供检查工具报告。
+```
+
+检查结果应包含标题跳级和重复标题信息，以及待办统计。工具采用行级分析，报告不等于完整 Markdown 标准校验。
+
+## Skill：只读检查
+
+在可选择 Skill 的智能体运行入口中，选择已启用的 `note-reviewer`，使用下面的请求：
+
+> 请查找“星灯资料站”笔记，读取原文，检查标题和待办结构，给出可核对的问题与来源。不要修改笔记，也不要补写原文没有的信息。
+
+运行需要可用模型及对应工具权限。可在 Trace 中查看实际工具调用；没有发生的调用不能当作已经检查。
+
+## 安装状态恢复
+
+通过当前版本安装的扩展会登记到本地安装库。关闭并重新启动服务后，可以回到管理页检查安装和启停状态。包文件被移动或修改时，应看到恢复提示并重新检查安装来源。
+
+从目录安装仍依赖原目录；ZIP 导入使用应用管理目录。卸载 ZIP 包会清理对应管理资源，目录安装的源码不会被删除。
@@ -1,8 +1,8 @@
---
+***
+
 title: Python 基础语法
 tags: python, 编程
---
-
+----------------
 # 变量与类型

 Python 是动态类型语言，变量无需声明类型。
@@ -16,3 +16,35 @@ Python 是动态类型语言，变量无需声明类型。
 ### 函数定义

 使用 def 关键字定义函数，支持默认参数与关键字参数。
+
+```python
+n = int(input())
+total = 0
+count_above_60 = 0
+scores = []
+min_score = float('inf')
+max_score = -float('inf')
+
+for i in range(n):
+    while True:
+        items = int(input(f"请输入第{i+1}个学生的成绩: "))
+        if 0 <= items <= 100:
+            break
+        print("分数无效，请重新输入")
+    scores.append(items)
+    total += items
+    if items > max_score:
+        max_score = items
+    if items < min_score:
+        min_score = items
+    if items > 60:
+        count_above_60 += 1
+print("=====成绩统计结果=====")
+print(f"所有成绩: {scores}")
+print(f"最高分: {max_score}")
+print(f"最低分: {min_score}")
+print(f"平均分: {total / n}")
+print(f"60分以上学生人数: {count_above_60}")
+print(f"60分以上学生占比: {count_above_60 / n * 100}%")
+```
+
@@ -1,7 +1,8 @@
---
+***
+
 title: 向量数据库与相似度检索
 tags: 向量数据库, 检索
---
+---------------

 # 向量数据库

@@ -18,3 +19,5 @@ sqlite-vec 是一个轻量的 SQLite 向量扩展，支持 vec0 虚拟表。
 ## 混合检索

 结合全文检索与向量检索，用 RRF 融合排序结果。
+
+