noteconnection 1.6.6 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +93 -25
- package/dist/src/frontend/README.md +93 -25
- package/dist/src/frontend/app.js +1524 -65
- package/dist/src/frontend/notemd.js +162 -2
- package/dist/src/frontend/path_app.js +70 -9
- package/dist/src/frontend/reader.js +809 -143
- package/dist/src/frontend/settings.js +362 -37
- package/dist/src/frontend/simulationWorker.js +241 -6
- package/dist/src/frontend/source_manager.js +6 -3
- package/dist/src/frontend/styles.css +133 -0
- package/dist/src/markdown/MarkdownGateway.js +921 -0
- package/dist/src/markdown/MarkdownGateway.test.js +195 -0
- package/dist/src/notemd/AppConfigToml.js +201 -1
- package/dist/src/notemd/constants.js +4 -0
- package/dist/src/notemd.app_config_toml.test.js +112 -0
- package/dist/src/notemd.embed.refresh.contract.test.js +63 -0
- package/dist/src/notemd.server.integration.test.js +140 -0
- package/dist/src/server.js +398 -0
- package/dist/src/tauri.sidecar.cleanup.contract.test.js +1 -1
- package/package.json +11 -3
package/README.md
CHANGED
|
@@ -285,6 +285,7 @@ Managing your knowledge base source is now easier than ever.
|
|
|
285
285
|
- **Reset**: Use **File > Reset to Default** to return to the bundled demo notes.
|
|
286
286
|
- **Config Path Overrides**: Set `NOTE_CONNECTION_CONFIG_PATH` (full file path) or `NOTE_CONNECTION_CONFIG_DIR` (directory) to customize where `app_config.toml` is stored.
|
|
287
287
|
- **Window Behavior Tuning**: Edit `[multi_window]` in `app_config.toml` (`single_window_mode`, `hide_tauri_when_pathmode_opens`, `restore_tauri_when_pathmode_exits`, `confirm_before_full_shutdown_from_godot`, `sync_language`).
|
|
288
|
+
- **Reader Protocol Tuning**: Edit `[frontend_settings.reading]` to control markdown rendering runtime (`markdown_engine`, `chunk_block_size`, `prefetch_blocks`, `index_cache_ttl_sec`, `max_doc_bytes`).
|
|
288
289
|
- **Detailed Config Guide**: See [`docs/en/app_config.toml_guide.md`](docs/en/app_config.toml_guide.md) and template [`docs/examples/app_config.template.toml`](docs/examples/app_config.template.toml).
|
|
289
290
|
|
|
290
291
|
```toml
|
|
@@ -298,8 +299,32 @@ hide_tauri_when_pathmode_opens = true
|
|
|
298
299
|
restore_tauri_when_pathmode_exits = true
|
|
299
300
|
confirm_before_full_shutdown_from_godot = true
|
|
300
301
|
sync_language = true
|
|
302
|
+
|
|
303
|
+
[frontend_settings.reading]
|
|
304
|
+
mode = "window"
|
|
305
|
+
markdown_engine = "auto" # "legacy" | "pulldown" | "auto"
|
|
306
|
+
chunk_block_size = 36
|
|
307
|
+
prefetch_blocks = 8
|
|
308
|
+
index_cache_ttl_sec = 1800
|
|
309
|
+
max_doc_bytes = 100663296
|
|
301
310
|
```
|
|
302
311
|
|
|
312
|
+
### Markdown Reader Protocol (v1.6.8)
|
|
313
|
+
|
|
314
|
+
- **Dual-engine gray release**:
|
|
315
|
+
- `markdown_engine = "auto"`: prefer `pulldown-cmark`, fallback to legacy on failure.
|
|
316
|
+
- `markdown_engine = "pulldown"`: keep automatic fallback to legacy to avoid blank readers.
|
|
317
|
+
- `markdown_engine = "legacy"`: force original parser path.
|
|
318
|
+
- **Unified cross-window behavior**: Tauri reader and Godot reader now both consume the same sidecar markdown protocol (`index/chunk/resolve-node/resolve-wiki`).
|
|
319
|
+
- **Large file stability**: reader no longer requires single-shot full markdown payloads and supports block-based incremental loading.
|
|
320
|
+
- **Mermaid reliability hardening**:
|
|
321
|
+
- Godot reader Mermaid rendering now uses `renderer = "auto"` so it can prefer frontend bridge and automatically fallback to local `resvg` when bridge render is unavailable.
|
|
322
|
+
- Mermaid fences must start on a new line; inline `$$```mermaid` patterns can break block classification.
|
|
323
|
+
- Use `npm run verify:markdown:mermaid:fence -- Knowledge_Base/testconcept` to catch malformed inline Mermaid fences before release.
|
|
324
|
+
- **Local MCP web-debug baseline (Runbrowser)**:
|
|
325
|
+
- Build locally from source: `pnpm --filter @jiweiyuan/runbrowser-server build`, `pnpm --filter @jiweiyuan/runbrowser-core build`, `pnpm --filter @jiweiyuan/runbrowser-mcp build`.
|
|
326
|
+
- Run local MCP entrypoint: `node E:\Knowledge_project\tools\runbrowser\packages\mcp\bin.js`.
|
|
327
|
+
|
|
303
328
|
## 🏗️ Build & Deployment
|
|
304
329
|
|
|
305
330
|
For developers building from source, NoteConnection offers two build modes:
|
|
@@ -319,19 +344,18 @@ For developers building from source, NoteConnection offers two build modes:
|
|
|
319
344
|
- Run mapping validation: `npm run docs:diataxis:check`.
|
|
320
345
|
- Run local docs site preview: `npm run docs:site:serve`.
|
|
321
346
|
- Build static docs site: `npm run docs:site:build`.
|
|
322
|
-
-
|
|
323
|
-
|
|
324
|
-
- Public mirror (fallback): `https://jacobinwwey.github.io/NoteConnection/`.
|
|
347
|
+
- GitHub Pages Docs Portal (project site): `https://jacobinwwey.github.io/NoteConnection/`.
|
|
348
|
+
- Host root (for routing baseline): `https://jacobinwwey.github.io/`.
|
|
325
349
|
- Recommended lookup entry points:
|
|
326
350
|
- Users: `/diataxis/zh/tutorials/first-run/` or `/diataxis/en/tutorials/first-run/`
|
|
327
351
|
- Developers: `/diataxis/en/reference/interfaces-and-runtime/` and `/diataxis/en/reference/release-and-governance/`
|
|
328
|
-
-
|
|
329
|
-
-
|
|
330
|
-
-
|
|
352
|
+
- CI auto publish workflow (GitHub Pages): `.github/workflows/docs-github-pages-publish.yml`.
|
|
353
|
+
- Manual rollback entry: run workflow dispatch and set `git_ref` to a stable tag/commit.
|
|
354
|
+
- MkDocs base/path can be overridden by environment variables: `MKDOCS_SITE_URL`, `MKDOCS_BASE_PATH`.
|
|
331
355
|
- CI policy gate for docs mapping and site build: `.github/workflows/docs-diataxis-site.yml`.
|
|
332
|
-
-
|
|
333
|
-
- English: [`docs/en/
|
|
334
|
-
- 中文: [`docs/zh/
|
|
356
|
+
- Docs release + rollback runbook:
|
|
357
|
+
- English: [`docs/en/docs_release_and_rollback.md`](docs/en/docs_release_and_rollback.md)
|
|
358
|
+
- 中文: [`docs/zh/docs_release_and_rollback.md`](docs/zh/docs_release_and_rollback.md)
|
|
335
359
|
|
|
336
360
|
## 🛠️ Hardware & Driver Requirements (AMDGPU)
|
|
337
361
|
|
|
@@ -346,6 +370,16 @@ For optimal performance with "GPU Optimised Rendering", especially on AMD RDNA c
|
|
|
346
370
|
|
|
347
371
|
## 📅 Changelog
|
|
348
372
|
|
|
373
|
+
### v1.6.7 - Docs Governance Cleanup & GitHub Pages Stabilization (2026-03-29)
|
|
374
|
+
- Removed unrelated external community UI documentation references from the repository documentation system.
|
|
375
|
+
- Replaced legacy external runbooks with project-owned docs operations runbooks:
|
|
376
|
+
- `docs/en/docs_release_and_rollback.md`
|
|
377
|
+
- `docs/zh/docs_release_and_rollback.md`
|
|
378
|
+
- Updated Diataxis governance mapping and cross-links to use the new canonical runbook paths.
|
|
379
|
+
- Added GitHub Pages preflight verification in docs publish workflow to surface clear warnings when Pages is not enabled.
|
|
380
|
+
- Resolved docs portal 404 condition by enabling repository Pages with `gh-pages` branch as publish source.
|
|
381
|
+
- Prepared formal release metadata and version alignment to `1.6.7` (npm + Tauri).
|
|
382
|
+
|
|
349
383
|
### v1.6.6 - Unified Provider Runtime & TOML Settings Consolidation (2026-03-26)
|
|
350
384
|
- Upgraded NoteMD API calling flow to a definition-driven provider architecture inspired by recent obsidian-NotEMD and cline patterns.
|
|
351
385
|
- Added transport-based dispatch (openai-compatible, anthropic, google, azure-openai, ollama) and provider metadata (apiKeyMode, apiTestMode, category).
|
|
@@ -358,11 +392,11 @@ For optimal performance with "GPU Optimised Rendering", especially on AMD RDNA c
|
|
|
358
392
|
- Updated bilingual documentation and templates for v1.6.6 schema and operations.
|
|
359
393
|
### v1.6.5 - Documentation Portal Update (2026-03-26)
|
|
360
394
|
|
|
361
|
-
- Published MkDocs documentation to
|
|
395
|
+
- Published MkDocs documentation to GitHub Pages project site.
|
|
362
396
|
- Added bilingual README guidance for docs lookup paths (user/tutorial and developer/reference entry points).
|
|
363
|
-
- Standardized docs publish
|
|
397
|
+
- Standardized docs publish flow for maintainers:
|
|
364
398
|
- `npm run docs:site:build`
|
|
365
|
-
-
|
|
399
|
+
- `.github/workflows/docs-github-pages-publish.yml` (`workflow_dispatch` supports `git_ref` rollback)
|
|
366
400
|
### v1.6.0 - Unified Runtime, NoteMD Integration & Release Hardening (2026-03-23)
|
|
367
401
|
|
|
368
402
|
- **Tag Compare Snapshot (`v1.3.0..v1.6.0`)**:
|
|
@@ -919,7 +953,7 @@ For optimal performance with "GPU Optimised Rendering", especially on AMD RDNA c
|
|
|
919
953
|
## 中文文档
|
|
920
954
|
|
|
921
955
|
|
|
922
|
-
# 2026-03-
|
|
956
|
+
# 2026-03-29 v1.6.7
|
|
923
957
|
# NoteConnection: 层级知识图谱可视化系统
|
|
924
958
|
|
|
925
959
|
<img width="606" height="309" alt="banner" src="https://github.com/user-attachments/assets/92e90de5-2b1a-4398-8e8b-6e142c92b6a2" />
|
|
@@ -1191,6 +1225,7 @@ npm start -- --path "E:/Knowledge/ObsidianVault" --no-gpu
|
|
|
1191
1225
|
- **重置**: 使用 **文件 > 重置为默认** 返回由捆绑的演示笔记。
|
|
1192
1226
|
- **配置路径覆盖**: 可通过 `NOTE_CONNECTION_CONFIG_PATH`(完整文件路径)或 `NOTE_CONNECTION_CONFIG_DIR`(目录)自定义 `app_config.toml` 位置。
|
|
1193
1227
|
- **窗口行为可调**: 在 `app_config.toml` 的 `[multi_window]` 段调整 `single_window_mode`、`hide_tauri_when_pathmode_opens`、`restore_tauri_when_pathmode_exits`、`confirm_before_full_shutdown_from_godot`、`sync_language`。
|
|
1228
|
+
- **阅读协议可调**: 在 `[frontend_settings.reading]` 中统一调节 Markdown 渲染链路(`markdown_engine`、`chunk_block_size`、`prefetch_blocks`、`index_cache_ttl_sec`、`max_doc_bytes`)。
|
|
1194
1229
|
- **详细配置说明**: 参见 [`docs/zh/app_config.toml_guide.md`](docs/zh/app_config.toml_guide.md) 与模板 [`docs/examples/app_config.template.toml`](docs/examples/app_config.template.toml)。
|
|
1195
1230
|
|
|
1196
1231
|
```toml
|
|
@@ -1204,8 +1239,32 @@ hide_tauri_when_pathmode_opens = true
|
|
|
1204
1239
|
restore_tauri_when_pathmode_exits = true
|
|
1205
1240
|
confirm_before_full_shutdown_from_godot = true
|
|
1206
1241
|
sync_language = true
|
|
1242
|
+
|
|
1243
|
+
[frontend_settings.reading]
|
|
1244
|
+
mode = "window"
|
|
1245
|
+
markdown_engine = "auto" # "legacy" | "pulldown" | "auto"
|
|
1246
|
+
chunk_block_size = 36
|
|
1247
|
+
prefetch_blocks = 8
|
|
1248
|
+
index_cache_ttl_sec = 1800
|
|
1249
|
+
max_doc_bytes = 100663296
|
|
1207
1250
|
```
|
|
1208
1251
|
|
|
1252
|
+
### Markdown 阅读协议(v1.6.8)
|
|
1253
|
+
|
|
1254
|
+
- **双引擎灰度发布**:
|
|
1255
|
+
- `markdown_engine = "auto"`:优先 `pulldown-cmark`,失败自动回退 legacy。
|
|
1256
|
+
- `markdown_engine = "pulldown"`:仍保留自动回退 legacy,避免阅读器空白。
|
|
1257
|
+
- `markdown_engine = "legacy"`:强制使用旧解析链路。
|
|
1258
|
+
- **双窗口统一行为**:Tauri 阅读器与 Godot 阅读器都统一消费 sidecar Markdown 协议(`index/chunk/resolve-node/resolve-wiki`)。
|
|
1259
|
+
- **大文档稳定性提升**:阅读链路不再依赖单次整文全量载入,改为块级增量加载。
|
|
1260
|
+
- **Mermaid 稳定性加固**:
|
|
1261
|
+
- Godot 阅读器 Mermaid 渲染已切换为 `renderer = "auto"`,优先走前端桥接渲染,桥接不可用时自动回退本地 `resvg`。
|
|
1262
|
+
- Mermaid fenced code 必须独占新行起始;`$$```mermaid` 这类行内拼接会导致分块识别失败。
|
|
1263
|
+
- 发布前可执行 `npm run verify:markdown:mermaid:fence -- Knowledge_Base/testconcept`,提前拦截异常 Mermaid fence。
|
|
1264
|
+
- **本地 MCP 网页调试基线(Runbrowser)**:
|
|
1265
|
+
- 建议按源码本地构建:`pnpm --filter @jiweiyuan/runbrowser-server build`、`pnpm --filter @jiweiyuan/runbrowser-core build`、`pnpm --filter @jiweiyuan/runbrowser-mcp build`。
|
|
1266
|
+
- 本地 MCP 入口:`node E:\Knowledge_project\tools\runbrowser\packages\mcp\bin.js`。
|
|
1267
|
+
|
|
1209
1268
|
## 🏗️ 构建与部署 (Build & Deployment)
|
|
1210
1269
|
|
|
1211
1270
|
对于从源码构建的开发者,NoteConnection 提供两种构建模式:
|
|
@@ -1225,19 +1284,18 @@ sync_language = true
|
|
|
1225
1284
|
- 映射一致性校验:`npm run docs:diataxis:check`。
|
|
1226
1285
|
- 本地预览文档站点:`npm run docs:site:serve`。
|
|
1227
1286
|
- 构建静态文档站点:`npm run docs:site:build`。
|
|
1228
|
-
-
|
|
1229
|
-
|
|
1230
|
-
- 公共镜像(兜底):`https://jacobinwwey.github.io/NoteConnection/`。
|
|
1287
|
+
- GitHub Pages 文档入口(project site):`https://jacobinwwey.github.io/NoteConnection/`。
|
|
1288
|
+
- 根域名(路由基线):`https://jacobinwwey.github.io/`。
|
|
1231
1289
|
- 推荐查询入口:
|
|
1232
1290
|
- 用户文档:`/diataxis/zh/tutorials/first-run/` 或 `/diataxis/en/tutorials/first-run/`
|
|
1233
1291
|
- 开发文档:`/diataxis/en/reference/interfaces-and-runtime/` 与 `/diataxis/en/reference/release-and-governance/`
|
|
1234
|
-
-
|
|
1235
|
-
-
|
|
1236
|
-
-
|
|
1292
|
+
- CI 自动发布工作流(GitHub Pages):`.github/workflows/docs-github-pages-publish.yml`。
|
|
1293
|
+
- 手动回滚入口:运行 workflow_dispatch 并设置 `git_ref` 为稳定 tag/commit。
|
|
1294
|
+
- MkDocs base/path 可通过环境变量覆盖:`MKDOCS_SITE_URL`、`MKDOCS_BASE_PATH`。
|
|
1237
1295
|
- CI 文档治理工作流:`.github/workflows/docs-diataxis-site.yml`。
|
|
1238
|
-
-
|
|
1239
|
-
- English:[`docs/en/
|
|
1240
|
-
- 中文:[`docs/zh/
|
|
1296
|
+
- 文档发布与回滚运行手册:
|
|
1297
|
+
- English:[`docs/en/docs_release_and_rollback.md`](docs/en/docs_release_and_rollback.md)
|
|
1298
|
+
- 中文:[`docs/zh/docs_release_and_rollback.md`](docs/zh/docs_release_and_rollback.md)
|
|
1241
1299
|
|
|
1242
1300
|
---
|
|
1243
1301
|
|
|
@@ -1245,6 +1303,16 @@ sync_language = true
|
|
|
1245
1303
|
|
|
1246
1304
|
## 更新日志 (Changelog)
|
|
1247
1305
|
|
|
1306
|
+
### v1.6.7 - 文档治理清理与 GitHub Pages 稳定性修复 (2026-03-29)
|
|
1307
|
+
- 清理并移除了项目文档体系中与本项目无关的外部社区界面文档引用。
|
|
1308
|
+
- 将历史外部手册替换为项目内通用文档运维手册:
|
|
1309
|
+
- `docs/en/docs_release_and_rollback.md`
|
|
1310
|
+
- `docs/zh/docs_release_and_rollback.md`
|
|
1311
|
+
- 同步更新 Diataxis 映射与跨文档链接,确保权威来源路径一致。
|
|
1312
|
+
- 在文档发布工作流新增 GitHub Pages 预检步骤,未启用 Pages 时给出明确告警。
|
|
1313
|
+
- 已通过仓库 Pages 启用与 `gh-pages` 源配置修复文档站点 404 问题。
|
|
1314
|
+
- 完成下个正式版本发布准备,并将版本统一到 `1.6.7`(npm + Tauri)。
|
|
1315
|
+
|
|
1248
1316
|
### v1.6.6 - Provider 运行时流程与 TOML 配置统一 (2026-03-26)
|
|
1249
1317
|
- 参考 obsidian-NotEMD 与 cline 的 Provider 策略,重构 NoteMD API 调用流为定义驱动。
|
|
1250
1318
|
- 新增 transport 分发(openai-compatible / anthropic / google / azure-openai / ollama)与 provider 元数据(apiKeyMode、apiTestMode、category)。
|
|
@@ -1258,11 +1326,11 @@ sync_language = true
|
|
|
1258
1326
|
|
|
1259
1327
|
### v1.6.5 - 文档门户更新 (2026-03-26)
|
|
1260
1328
|
|
|
1261
|
-
- 已将 MkDocs 文档发布到
|
|
1329
|
+
- 已将 MkDocs 文档发布到 GitHub Pages project site。
|
|
1262
1330
|
- 在 README 中补充了面向用户与开发者的中英文文档检索入口。
|
|
1263
|
-
-
|
|
1331
|
+
- 维护者发布流程统一为:
|
|
1264
1332
|
- `npm run docs:site:build`
|
|
1265
|
-
-
|
|
1333
|
+
- `.github/workflows/docs-github-pages-publish.yml`(`workflow_dispatch` 支持 `git_ref` 回滚)
|
|
1266
1334
|
|
|
1267
1335
|
### v1.6.0 - 单窗口运行时、NoteMD 集成与发布加固 (2026-03-23)
|
|
1268
1336
|
|
|
@@ -285,6 +285,7 @@ Managing your knowledge base source is now easier than ever.
|
|
|
285
285
|
- **Reset**: Use **File > Reset to Default** to return to the bundled demo notes.
|
|
286
286
|
- **Config Path Overrides**: Set `NOTE_CONNECTION_CONFIG_PATH` (full file path) or `NOTE_CONNECTION_CONFIG_DIR` (directory) to customize where `app_config.toml` is stored.
|
|
287
287
|
- **Window Behavior Tuning**: Edit `[multi_window]` in `app_config.toml` (`single_window_mode`, `hide_tauri_when_pathmode_opens`, `restore_tauri_when_pathmode_exits`, `confirm_before_full_shutdown_from_godot`, `sync_language`).
|
|
288
|
+
- **Reader Protocol Tuning**: Edit `[frontend_settings.reading]` to control markdown rendering runtime (`markdown_engine`, `chunk_block_size`, `prefetch_blocks`, `index_cache_ttl_sec`, `max_doc_bytes`).
|
|
288
289
|
- **Detailed Config Guide**: See [`docs/en/app_config.toml_guide.md`](docs/en/app_config.toml_guide.md) and template [`docs/examples/app_config.template.toml`](docs/examples/app_config.template.toml).
|
|
289
290
|
|
|
290
291
|
```toml
|
|
@@ -298,8 +299,32 @@ hide_tauri_when_pathmode_opens = true
|
|
|
298
299
|
restore_tauri_when_pathmode_exits = true
|
|
299
300
|
confirm_before_full_shutdown_from_godot = true
|
|
300
301
|
sync_language = true
|
|
302
|
+
|
|
303
|
+
[frontend_settings.reading]
|
|
304
|
+
mode = "window"
|
|
305
|
+
markdown_engine = "auto" # "legacy" | "pulldown" | "auto"
|
|
306
|
+
chunk_block_size = 36
|
|
307
|
+
prefetch_blocks = 8
|
|
308
|
+
index_cache_ttl_sec = 1800
|
|
309
|
+
max_doc_bytes = 100663296
|
|
301
310
|
```
|
|
302
311
|
|
|
312
|
+
### Markdown Reader Protocol (v1.6.8)
|
|
313
|
+
|
|
314
|
+
- **Dual-engine gray release**:
|
|
315
|
+
- `markdown_engine = "auto"`: prefer `pulldown-cmark`, fallback to legacy on failure.
|
|
316
|
+
- `markdown_engine = "pulldown"`: keep automatic fallback to legacy to avoid blank readers.
|
|
317
|
+
- `markdown_engine = "legacy"`: force original parser path.
|
|
318
|
+
- **Unified cross-window behavior**: Tauri reader and Godot reader now both consume the same sidecar markdown protocol (`index/chunk/resolve-node/resolve-wiki`).
|
|
319
|
+
- **Large file stability**: reader no longer requires single-shot full markdown payloads and supports block-based incremental loading.
|
|
320
|
+
- **Mermaid reliability hardening**:
|
|
321
|
+
- Godot reader Mermaid rendering now uses `renderer = "auto"` so it can prefer frontend bridge and automatically fallback to local `resvg` when bridge render is unavailable.
|
|
322
|
+
- Mermaid fences must start on a new line; inline `$$```mermaid` patterns can break block classification.
|
|
323
|
+
- Use `npm run verify:markdown:mermaid:fence -- Knowledge_Base/testconcept` to catch malformed inline Mermaid fences before release.
|
|
324
|
+
- **Local MCP web-debug baseline (Runbrowser)**:
|
|
325
|
+
- Build locally from source: `pnpm --filter @jiweiyuan/runbrowser-server build`, `pnpm --filter @jiweiyuan/runbrowser-core build`, `pnpm --filter @jiweiyuan/runbrowser-mcp build`.
|
|
326
|
+
- Run local MCP entrypoint: `node E:\Knowledge_project\tools\runbrowser\packages\mcp\bin.js`.
|
|
327
|
+
|
|
303
328
|
## 🏗️ Build & Deployment
|
|
304
329
|
|
|
305
330
|
For developers building from source, NoteConnection offers two build modes:
|
|
@@ -319,19 +344,18 @@ For developers building from source, NoteConnection offers two build modes:
|
|
|
319
344
|
- Run mapping validation: `npm run docs:diataxis:check`.
|
|
320
345
|
- Run local docs site preview: `npm run docs:site:serve`.
|
|
321
346
|
- Build static docs site: `npm run docs:site:build`.
|
|
322
|
-
-
|
|
323
|
-
|
|
324
|
-
- Public mirror (fallback): `https://jacobinwwey.github.io/NoteConnection/`.
|
|
347
|
+
- GitHub Pages Docs Portal (project site): `https://jacobinwwey.github.io/NoteConnection/`.
|
|
348
|
+
- Host root (for routing baseline): `https://jacobinwwey.github.io/`.
|
|
325
349
|
- Recommended lookup entry points:
|
|
326
350
|
- Users: `/diataxis/zh/tutorials/first-run/` or `/diataxis/en/tutorials/first-run/`
|
|
327
351
|
- Developers: `/diataxis/en/reference/interfaces-and-runtime/` and `/diataxis/en/reference/release-and-governance/`
|
|
328
|
-
-
|
|
329
|
-
-
|
|
330
|
-
-
|
|
352
|
+
- CI auto publish workflow (GitHub Pages): `.github/workflows/docs-github-pages-publish.yml`.
|
|
353
|
+
- Manual rollback entry: run workflow dispatch and set `git_ref` to a stable tag/commit.
|
|
354
|
+
- MkDocs base/path can be overridden by environment variables: `MKDOCS_SITE_URL`, `MKDOCS_BASE_PATH`.
|
|
331
355
|
- CI policy gate for docs mapping and site build: `.github/workflows/docs-diataxis-site.yml`.
|
|
332
|
-
-
|
|
333
|
-
- English: [`docs/en/
|
|
334
|
-
- 中文: [`docs/zh/
|
|
356
|
+
- Docs release + rollback runbook:
|
|
357
|
+
- English: [`docs/en/docs_release_and_rollback.md`](docs/en/docs_release_and_rollback.md)
|
|
358
|
+
- 中文: [`docs/zh/docs_release_and_rollback.md`](docs/zh/docs_release_and_rollback.md)
|
|
335
359
|
|
|
336
360
|
## 🛠️ Hardware & Driver Requirements (AMDGPU)
|
|
337
361
|
|
|
@@ -346,6 +370,16 @@ For optimal performance with "GPU Optimised Rendering", especially on AMD RDNA c
|
|
|
346
370
|
|
|
347
371
|
## 📅 Changelog
|
|
348
372
|
|
|
373
|
+
### v1.6.7 - Docs Governance Cleanup & GitHub Pages Stabilization (2026-03-29)
|
|
374
|
+
- Removed unrelated external community UI documentation references from the repository documentation system.
|
|
375
|
+
- Replaced legacy external runbooks with project-owned docs operations runbooks:
|
|
376
|
+
- `docs/en/docs_release_and_rollback.md`
|
|
377
|
+
- `docs/zh/docs_release_and_rollback.md`
|
|
378
|
+
- Updated Diataxis governance mapping and cross-links to use the new canonical runbook paths.
|
|
379
|
+
- Added GitHub Pages preflight verification in docs publish workflow to surface clear warnings when Pages is not enabled.
|
|
380
|
+
- Resolved docs portal 404 condition by enabling repository Pages with `gh-pages` branch as publish source.
|
|
381
|
+
- Prepared formal release metadata and version alignment to `1.6.7` (npm + Tauri).
|
|
382
|
+
|
|
349
383
|
### v1.6.6 - Unified Provider Runtime & TOML Settings Consolidation (2026-03-26)
|
|
350
384
|
- Upgraded NoteMD API calling flow to a definition-driven provider architecture inspired by recent obsidian-NotEMD and cline patterns.
|
|
351
385
|
- Added transport-based dispatch (openai-compatible, anthropic, google, azure-openai, ollama) and provider metadata (apiKeyMode, apiTestMode, category).
|
|
@@ -358,11 +392,11 @@ For optimal performance with "GPU Optimised Rendering", especially on AMD RDNA c
|
|
|
358
392
|
- Updated bilingual documentation and templates for v1.6.6 schema and operations.
|
|
359
393
|
### v1.6.5 - Documentation Portal Update (2026-03-26)
|
|
360
394
|
|
|
361
|
-
- Published MkDocs documentation to
|
|
395
|
+
- Published MkDocs documentation to GitHub Pages project site.
|
|
362
396
|
- Added bilingual README guidance for docs lookup paths (user/tutorial and developer/reference entry points).
|
|
363
|
-
- Standardized docs publish
|
|
397
|
+
- Standardized docs publish flow for maintainers:
|
|
364
398
|
- `npm run docs:site:build`
|
|
365
|
-
-
|
|
399
|
+
- `.github/workflows/docs-github-pages-publish.yml` (`workflow_dispatch` supports `git_ref` rollback)
|
|
366
400
|
### v1.6.0 - Unified Runtime, NoteMD Integration & Release Hardening (2026-03-23)
|
|
367
401
|
|
|
368
402
|
- **Tag Compare Snapshot (`v1.3.0..v1.6.0`)**:
|
|
@@ -919,7 +953,7 @@ For optimal performance with "GPU Optimised Rendering", especially on AMD RDNA c
|
|
|
919
953
|
## 中文文档
|
|
920
954
|
|
|
921
955
|
|
|
922
|
-
# 2026-03-
|
|
956
|
+
# 2026-03-29 v1.6.7
|
|
923
957
|
# NoteConnection: 层级知识图谱可视化系统
|
|
924
958
|
|
|
925
959
|
<img width="606" height="309" alt="banner" src="https://github.com/user-attachments/assets/92e90de5-2b1a-4398-8e8b-6e142c92b6a2" />
|
|
@@ -1191,6 +1225,7 @@ npm start -- --path "E:/Knowledge/ObsidianVault" --no-gpu
|
|
|
1191
1225
|
- **重置**: 使用 **文件 > 重置为默认** 返回由捆绑的演示笔记。
|
|
1192
1226
|
- **配置路径覆盖**: 可通过 `NOTE_CONNECTION_CONFIG_PATH`(完整文件路径)或 `NOTE_CONNECTION_CONFIG_DIR`(目录)自定义 `app_config.toml` 位置。
|
|
1193
1227
|
- **窗口行为可调**: 在 `app_config.toml` 的 `[multi_window]` 段调整 `single_window_mode`、`hide_tauri_when_pathmode_opens`、`restore_tauri_when_pathmode_exits`、`confirm_before_full_shutdown_from_godot`、`sync_language`。
|
|
1228
|
+
- **阅读协议可调**: 在 `[frontend_settings.reading]` 中统一调节 Markdown 渲染链路(`markdown_engine`、`chunk_block_size`、`prefetch_blocks`、`index_cache_ttl_sec`、`max_doc_bytes`)。
|
|
1194
1229
|
- **详细配置说明**: 参见 [`docs/zh/app_config.toml_guide.md`](docs/zh/app_config.toml_guide.md) 与模板 [`docs/examples/app_config.template.toml`](docs/examples/app_config.template.toml)。
|
|
1195
1230
|
|
|
1196
1231
|
```toml
|
|
@@ -1204,8 +1239,32 @@ hide_tauri_when_pathmode_opens = true
|
|
|
1204
1239
|
restore_tauri_when_pathmode_exits = true
|
|
1205
1240
|
confirm_before_full_shutdown_from_godot = true
|
|
1206
1241
|
sync_language = true
|
|
1242
|
+
|
|
1243
|
+
[frontend_settings.reading]
|
|
1244
|
+
mode = "window"
|
|
1245
|
+
markdown_engine = "auto" # "legacy" | "pulldown" | "auto"
|
|
1246
|
+
chunk_block_size = 36
|
|
1247
|
+
prefetch_blocks = 8
|
|
1248
|
+
index_cache_ttl_sec = 1800
|
|
1249
|
+
max_doc_bytes = 100663296
|
|
1207
1250
|
```
|
|
1208
1251
|
|
|
1252
|
+
### Markdown 阅读协议(v1.6.8)
|
|
1253
|
+
|
|
1254
|
+
- **双引擎灰度发布**:
|
|
1255
|
+
- `markdown_engine = "auto"`:优先 `pulldown-cmark`,失败自动回退 legacy。
|
|
1256
|
+
- `markdown_engine = "pulldown"`:仍保留自动回退 legacy,避免阅读器空白。
|
|
1257
|
+
- `markdown_engine = "legacy"`:强制使用旧解析链路。
|
|
1258
|
+
- **双窗口统一行为**:Tauri 阅读器与 Godot 阅读器都统一消费 sidecar Markdown 协议(`index/chunk/resolve-node/resolve-wiki`)。
|
|
1259
|
+
- **大文档稳定性提升**:阅读链路不再依赖单次整文全量载入,改为块级增量加载。
|
|
1260
|
+
- **Mermaid 稳定性加固**:
|
|
1261
|
+
- Godot 阅读器 Mermaid 渲染已切换为 `renderer = "auto"`,优先走前端桥接渲染,桥接不可用时自动回退本地 `resvg`。
|
|
1262
|
+
- Mermaid fenced code 必须独占新行起始;`$$```mermaid` 这类行内拼接会导致分块识别失败。
|
|
1263
|
+
- 发布前可执行 `npm run verify:markdown:mermaid:fence -- Knowledge_Base/testconcept`,提前拦截异常 Mermaid fence。
|
|
1264
|
+
- **本地 MCP 网页调试基线(Runbrowser)**:
|
|
1265
|
+
- 建议按源码本地构建:`pnpm --filter @jiweiyuan/runbrowser-server build`、`pnpm --filter @jiweiyuan/runbrowser-core build`、`pnpm --filter @jiweiyuan/runbrowser-mcp build`。
|
|
1266
|
+
- 本地 MCP 入口:`node E:\Knowledge_project\tools\runbrowser\packages\mcp\bin.js`。
|
|
1267
|
+
|
|
1209
1268
|
## 🏗️ 构建与部署 (Build & Deployment)
|
|
1210
1269
|
|
|
1211
1270
|
对于从源码构建的开发者,NoteConnection 提供两种构建模式:
|
|
@@ -1225,19 +1284,18 @@ sync_language = true
|
|
|
1225
1284
|
- 映射一致性校验:`npm run docs:diataxis:check`。
|
|
1226
1285
|
- 本地预览文档站点:`npm run docs:site:serve`。
|
|
1227
1286
|
- 构建静态文档站点:`npm run docs:site:build`。
|
|
1228
|
-
-
|
|
1229
|
-
|
|
1230
|
-
- 公共镜像(兜底):`https://jacobinwwey.github.io/NoteConnection/`。
|
|
1287
|
+
- GitHub Pages 文档入口(project site):`https://jacobinwwey.github.io/NoteConnection/`。
|
|
1288
|
+
- 根域名(路由基线):`https://jacobinwwey.github.io/`。
|
|
1231
1289
|
- 推荐查询入口:
|
|
1232
1290
|
- 用户文档:`/diataxis/zh/tutorials/first-run/` 或 `/diataxis/en/tutorials/first-run/`
|
|
1233
1291
|
- 开发文档:`/diataxis/en/reference/interfaces-and-runtime/` 与 `/diataxis/en/reference/release-and-governance/`
|
|
1234
|
-
-
|
|
1235
|
-
-
|
|
1236
|
-
-
|
|
1292
|
+
- CI 自动发布工作流(GitHub Pages):`.github/workflows/docs-github-pages-publish.yml`。
|
|
1293
|
+
- 手动回滚入口:运行 workflow_dispatch 并设置 `git_ref` 为稳定 tag/commit。
|
|
1294
|
+
- MkDocs base/path 可通过环境变量覆盖:`MKDOCS_SITE_URL`、`MKDOCS_BASE_PATH`。
|
|
1237
1295
|
- CI 文档治理工作流:`.github/workflows/docs-diataxis-site.yml`。
|
|
1238
|
-
-
|
|
1239
|
-
- English:[`docs/en/
|
|
1240
|
-
- 中文:[`docs/zh/
|
|
1296
|
+
- 文档发布与回滚运行手册:
|
|
1297
|
+
- English:[`docs/en/docs_release_and_rollback.md`](docs/en/docs_release_and_rollback.md)
|
|
1298
|
+
- 中文:[`docs/zh/docs_release_and_rollback.md`](docs/zh/docs_release_and_rollback.md)
|
|
1241
1299
|
|
|
1242
1300
|
---
|
|
1243
1301
|
|
|
@@ -1245,6 +1303,16 @@ sync_language = true
|
|
|
1245
1303
|
|
|
1246
1304
|
## 更新日志 (Changelog)
|
|
1247
1305
|
|
|
1306
|
+
### v1.6.7 - 文档治理清理与 GitHub Pages 稳定性修复 (2026-03-29)
|
|
1307
|
+
- 清理并移除了项目文档体系中与本项目无关的外部社区界面文档引用。
|
|
1308
|
+
- 将历史外部手册替换为项目内通用文档运维手册:
|
|
1309
|
+
- `docs/en/docs_release_and_rollback.md`
|
|
1310
|
+
- `docs/zh/docs_release_and_rollback.md`
|
|
1311
|
+
- 同步更新 Diataxis 映射与跨文档链接,确保权威来源路径一致。
|
|
1312
|
+
- 在文档发布工作流新增 GitHub Pages 预检步骤,未启用 Pages 时给出明确告警。
|
|
1313
|
+
- 已通过仓库 Pages 启用与 `gh-pages` 源配置修复文档站点 404 问题。
|
|
1314
|
+
- 完成下个正式版本发布准备,并将版本统一到 `1.6.7`(npm + Tauri)。
|
|
1315
|
+
|
|
1248
1316
|
### v1.6.6 - Provider 运行时流程与 TOML 配置统一 (2026-03-26)
|
|
1249
1317
|
- 参考 obsidian-NotEMD 与 cline 的 Provider 策略,重构 NoteMD API 调用流为定义驱动。
|
|
1250
1318
|
- 新增 transport 分发(openai-compatible / anthropic / google / azure-openai / ollama)与 provider 元数据(apiKeyMode、apiTestMode、category)。
|
|
@@ -1258,11 +1326,11 @@ sync_language = true
|
|
|
1258
1326
|
|
|
1259
1327
|
### v1.6.5 - 文档门户更新 (2026-03-26)
|
|
1260
1328
|
|
|
1261
|
-
- 已将 MkDocs 文档发布到
|
|
1329
|
+
- 已将 MkDocs 文档发布到 GitHub Pages project site。
|
|
1262
1330
|
- 在 README 中补充了面向用户与开发者的中英文文档检索入口。
|
|
1263
|
-
-
|
|
1331
|
+
- 维护者发布流程统一为:
|
|
1264
1332
|
- `npm run docs:site:build`
|
|
1265
|
-
-
|
|
1333
|
+
- `.github/workflows/docs-github-pages-publish.yml`(`workflow_dispatch` 支持 `git_ref` 回滚)
|
|
1266
1334
|
|
|
1267
1335
|
### v1.6.0 - 单窗口运行时、NoteMD 集成与发布加固 (2026-03-23)
|
|
1268
1336
|
|