From e08cd839be93e16da06da24062e1a1434827f315 Mon Sep 17 00:00:00 2001 From: cflmy Date: Wed, 5 Aug 2026 16:25:38 +0800 Subject: [PATCH] Ignore vscode-extension on main and document the extension branch. Point editors to the vscode-extension branch for host work, mirroring the public/gh-pages split. Co-authored-by: Cursor --- .gitignore | 3 +++ README.md | 2 +- doc/README.md | 2 ++ doc/design/vscode-extension.md | 31 +++++++++++++++++++++++++++++++ 4 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 doc/design/vscode-extension.md diff --git a/.gitignore b/.gitignore index 8516cf1..ae8fa23 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,9 @@ /public/index.html /public/pages/ +# VS Code extension lives on branch `vscode-extension` only (see doc/design/vscode-extension.md) +/vscode-extension/ + # Python spike venv (local) spike/.venv/ spike/__pycache__/ diff --git a/README.md b/README.md index f75e4b7..d2fd006 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Marqdo 把 Markdown **标记当作编程语法**:同一个 `.mq.md` 文件, 欢迎访问 [marqdo 官方网站](https://www.marqdo.com/) 阅读更多特性与可执行文档。 -语法宪法:[doc/design/markdown-mapping.md](doc/design/markdown-mapping.md) · 调用实参:[call-arguments.md](doc/design/call-arguments.md) · 用户站:[user-site.md](doc/design/user-site.md) · 浏览:[view.md](doc/design/view.md) · 调试:[view-debug.md](doc/design/view-debug.md) · OKF 清单:[catalog-cli.md](doc/design/catalog-cli.md) · 金样例:[tests/](tests/) · 用户文档:[public/](public/) +语法宪法:[doc/design/markdown-mapping.md](doc/design/markdown-mapping.md) · 调用实参:[call-arguments.md](doc/design/call-arguments.md) · 用户站:[user-site.md](doc/design/user-site.md) · 浏览:[view.md](doc/design/view.md) · 调试:[view-debug.md](doc/design/view-debug.md) · OKF 清单:[catalog-cli.md](doc/design/catalog-cli.md) · VS Code 扩展:[vscode-extension.md](doc/design/vscode-extension.md)(分支 `vscode-extension`) · 金样例:[tests/](tests/) · 用户文档:[public/](public/) --- diff --git a/doc/README.md b/doc/README.md index 4b0dfab..7e614fe 100644 --- a/doc/README.md +++ b/doc/README.md @@ -34,6 +34,8 @@ | [design/view.md](design/view.md) | **`marqdo view` / `view output` 黑白极简 + 静态文档** | | [design/user-site.md](design/user-site.md) | **用户站:`public/` → `gh-pages`** | | [design/catalog-cli.md](design/catalog-cli.md) | **`marqdo catalog` / `sync` OKF 清单命令** | +| [design/view-debug.md](design/view-debug.md) | **`marqdo debug` 独立调试页** | +| [design/vscode-extension.md](design/vscode-extension.md) | **VS Code 扩展:分支 `vscode-extension`(main 不跟踪源码)** | | [design/bytecode.md](design/bytecode.md) | **M5 字节码 / 双后端** | | [design/pipeline-debug.md](design/pipeline-debug.md) | **流水线 `--dump-*` 可视调试** | | [dev-setup.md](dev-setup.md) | 开发环境配置(Rust M0) | diff --git a/doc/design/vscode-extension.md b/doc/design/vscode-extension.md new file mode 100644 index 0000000..f266a93 --- /dev/null +++ b/doc/design/vscode-extension.md @@ -0,0 +1,31 @@ +# VS Code 扩展(分支指针) + +| | | +|---|---| +| 状态 | **已定分支模型** | +| 日期 | 2026-08-05 | +| 代码分支 | **`vscode-extension`**(同仓库) | +| 目录 | 工作区 `vscode-extension/`(仅在该分支跟踪;**`main` 忽略**) | + +--- + +## 分工(类比 `public` / `gh-pages`) + +| 分支 | 内容 | +|------|------| +| `main` | Marqdo 语言 / CLI / `public/*.mq.md` 源;**不**存放扩展实现 | +| `vscode-extension` | VS Code 扩展源码、开发规范、TextMate 语法 | +| `gh-pages` | 用户站生成 HTML | + +```bash +git checkout vscode-extension +cd vscode-extension && npm install +``` + +规范入口(在该分支上阅读): + +- `vscode-extension/README.md` — 目标与目录 +- `vscode-extension/DEVELOPMENT.md` — 日常流程 +- `vscode-extension/ARCHITECTURE.md` — 与 CLI 边界 + +扩展是 CLI 的薄宿主;语法真相仍是 [markdown-mapping.md](markdown-mapping.md)。