184 lines
11 KiB
Markdown
184 lines
11 KiB
Markdown
# Marqdo
|
||
|
||
**代码即文档。文档即代码。文档即知识库。**
|
||
|
||
Marqdo 把 Markdown **标记当作编程语法**:同一个 `.mq.md` 文件,既是给人读的文稿,也是给机器跑的程序。写文档的过程就是在写可执行逻辑——大型项目里,说明、示例与实现不再分叉成三份真相。
|
||
|
||
欢迎访问 [marqdo 官方网站](https://www.marqdo.com/) 阅读更多特性与可执行文档。
|
||
|
||
语法宪法:[doc/design/markdown-mapping.md](doc/design/markdown-mapping.md) · 对象:[objects.md](doc/design/objects.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`**;提交约定 [vscode-extension-commit.md](doc/design/vscode-extension-commit.md)) · **AI Skill**:[skills/marqdo/](skills/marqdo/)(说明 [ai-skill.md](doc/design/ai-skill.md)) · 官方扩展:[ext-llm.md](doc/design/ext-llm.md)(`ext/llm`)· [ext-agent.md](doc/design/ext-agent.md)(智能体开发框架)· [ext-cli.md](doc/design/ext-cli.md)(`marqdo ext list/add/remove`) · 原生插件 ABI:[ext-abi.md](doc/design/ext-abi.md)(`lib/plugin`) · 金样例:[tests/](tests/) · 用户文档:[public/](public/) · 变更:[CHANGELOG.md](CHANGELOG.md)
|
||
|
||
---
|
||
|
||
## 为什么重要
|
||
|
||
| 痛点 | Marqdo 的答案 |
|
||
|------|----------------|
|
||
| 文档过期、示例跑不通 | **一份源文件**:叙述、结构与执行结果同源 |
|
||
| 知识散落在 Wiki / 注释 / 脚本里 | **`.mq.md` 即知识单元**,可浏览、可运行、可检索 |
|
||
| 人写给人看,AI / 工具另起一套 | **人机同读同写同构**:标记语言对人类友好,对解释器确定 |
|
||
| 大仓里「文档站」与「代码仓」脱节 | `view` 文档站 + `debug` 调试面 + `catalog` 清单,同一棵树长大 |
|
||
|
||
这不是「再做一个 Markdown 渲染器」,而是:**把文档升格为可解释的程序与可生长的知识库**,让协作在大型项目里依然站得住。
|
||
|
||
---
|
||
|
||
## 语法速览(v0.2)
|
||
|
||
| 标记 | 含义 |
|
||
|------|------|
|
||
| 无标记行 | 注释(空行分段) |
|
||
| `*…*` | 程序语句 |
|
||
| `**…**` | **返回值**(架构) |
|
||
| `****` / `**` + 空白 + `**` | **空返回**(`None`),并结束本函数体 |
|
||
| `> print …` 等 | 输出等副作用 = **普通函数**,非架构标记 |
|
||
| `#` | 对象 / 类型(构造体;`# main` = 入口) |
|
||
| `##` … | 函数 / 方法(按标题深度嵌套) |
|
||
| `` > `obj`.method … `` | 方法调用(`obj` 为带 `_type` 的 map) |
|
||
| `+` / `1.` … | 函数头下 `` + `名` `` = 形参;体内 `1.` `2.` … = 分支(`N. *` = else) |
|
||
| `-` | 循环(`` - `条件` `` 或 `` - [项](集合) `` / `` - [`项`](`集合`) ``) |
|
||
| 表格 | 集合 |
|
||
| 函数体内单独一行 `---` / `***` | **结束本函数体**(无返回值收束;见 mapping §11) |
|
||
| 文件开头成对 `---` … `---` | Frontmatter(元信息 / 导入),与函数结束符消歧 |
|
||
|
||
```markdown
|
||
# main
|
||
|
||
> 问候 谁=World
|
||
|
||
## 问候
|
||
+ `谁`
|
||
|
||
> print text=Hello `谁`!
|
||
|
||
---
|
||
|
||
## 加一
|
||
+ `n`
|
||
|
||
**`n` + 1**
|
||
```
|
||
|
||
完整约定:[markdown-mapping.md](doc/design/markdown-mapping.md)。
|
||
|
||
---
|
||
|
||
## 理念
|
||
|
||
1. **叙述默认安全**(无标记 = 注释)。
|
||
2. **返回是架构;打印只是函数。**
|
||
3. **代码即文档即知识库**:文稿可执行,执行可回看结构,结构可导航与调试。
|
||
4. **对齐 [OKF](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)(Open Knowledge Format)方向**:清单由工具从 `.mq.md` **自动生成**,不是手填配置——见下节与 [catalog-cli.md](doc/design/catalog-cli.md)。
|
||
5. **正经解释器(Rust)**:词法/行分类 → 语法 → 语义 → 树遍历(及字节码);**不用 Flex/Bison**。见 [路线图](doc/roadmap/interpreter.md)。
|
||
|
||
---
|
||
|
||
## OKF 风格清单(自动生成)
|
||
|
||
从源码派生 YAML / Markdown 知识包(勿手改生成物):
|
||
|
||
```bash
|
||
marqdo catalog [PATH] -o OUT_DIR
|
||
marqdo sync [PATH] -o OUT_DIR # catalog 的别名
|
||
```
|
||
|
||
| 参数 | 默认 | 说明 |
|
||
|------|------|------|
|
||
| `PATH` | `.` | 工程根或含 `.mq.md` 的目录 |
|
||
| `-o` / `--out` | `.marqdo` | 输出目录 |
|
||
|
||
产物示例:`catalog.yaml`、`index.md`、`modules/*.md`(`type: Marqdo Module` 等)。设计见 [generated-yaml-manifest.md](doc/design/generated-yaml-manifest.md) · 调研 [okf-and-marqdo.md](doc/research/okf-and-marqdo.md)。
|
||
|
||
智能体框架横向调研(LangGraph / CrewAI / 厂商 SDK 等 vs Marqdo 文档驱动优势):[agent-frameworks-and-marqdo.md](doc/research/agent-frameworks-and-marqdo.md) · 优化路线 [ext-agent-optimize.md](doc/roadmap/ext-agent-optimize.md)。
|
||
|
||
```bash
|
||
cargo run -- catalog public -o .marqdo
|
||
# 或已安装二进制时:
|
||
marqdo catalog public -o .marqdo
|
||
```
|
||
|
||
---
|
||
|
||
## 现状(v0.3.7)
|
||
|
||
- 映射与解释器:Phase I 树遍历 + 字节码后端可用;金样例在 `tests/`
|
||
- **对象**:`#` = 类型/构造,`##`+ = 函数/方法;见 [objects.md](doc/design/objects.md)
|
||
- **`marqdo view`**:文档浏览器(Structure + 函数大纲/搜索 + Execution + Variables 浮窗)
|
||
- **`marqdo debug`**:独立调试页(断点 / 单步 / locals;默认端口 7430;页面 favicon / 品牌使用官方 Logo)
|
||
- **`marqdo catalog` / `sync`**:OKF 风格 YAML + 模块概念页
|
||
- **`marqdo version --check`**:与 GitHub 最新 release 对比
|
||
- 标准库:**内置于二进制**(v0.1.2+);磁盘 `lib/` 或 `MARQDO_LIB` 可覆盖。模块含文本、表、**浏览器效应**、文件、系统、时间、JSON、网络、数学、外联、插件、**自写回**、**子任务**;**中层 Mid M1–M6**(`re`/`encoding`/`path`/`hash`/`secrets`/`csv`/`cli`/`log`/`uuid` 及中英对称库,见 [stdlib-mid.md](doc/design/stdlib-mid.md))
|
||
- **官方扩展库 `ext/`**(**非** stdlib,本版收口):
|
||
- **`web`**:W0–W7 + P3 + **W8**;**定制 C0–C4**;**宿主 H1–H2**(`proxy`/`invoke`,见 [ext-hosting.md](doc/roadmap/ext-hosting.md));示例 [marqdo-blog](examples/marqdo-blog/);生产路径见 [web-asgi-servers-and-marqdo.md](doc/design/web-asgi-servers-and-marqdo.md)
|
||
- **`quantum`**:Q0–Q7 + Q8a/b 主题 SVG;示例 [quantum-entanglement](examples/quantum-entanglement/)
|
||
- **`linalg`**:L0–L6 + 公式文档面(中缀 / `declare` / 展示化简);示例 [linalg-transpose](examples/linalg-transpose/) · [linalg-svd](examples/linalg-svd/) · [linalg-least-squares](examples/linalg-least-squares/)
|
||
- **`agent`**:A1–A4 + **MCP Server stdio**(`mcp_server`);宿主缺口见 [ext-hosting.md](doc/roadmap/ext-hosting.md) · [agent-framework-gaps-after-a4.md](doc/research/agent-framework-gaps-after-a4.md)
|
||
- **`llm`**:OpenAI 兼容对话
|
||
- 安装:`marqdo ext list` / `add …` / `remove`([ext-cli.md](doc/design/ext-cli.md);默认 `~/.marqdo/ext`)。原生插件先 `cargo build -p marqdo_plugin_*` 再 `ext add`
|
||
- **原生插件 ABI**:[`include/marqdo_abi.h`](include/marqdo_abi.h) · [ext-abi.md](doc/design/ext-abi.md);`plugins/{demo,agent,web,quantum,linalg}`
|
||
- **用户静态站**:`public/` → `view output` → CI 发布 [gh-pages](https://cflmy.github.io/marqdo/)
|
||
- **VS Code 扩展**:分支 **`vscode-extension`**(`main` 不跟踪源码;见 [vscode-extension-commit.md](doc/design/vscode-extension-commit.md));Release 附带 `.vsix`
|
||
- **浏览器 Marqdo(WASM)**:`marqdo wasm build` + 官方 bridge 自启(作者零业务 JS;桥内可含列表/路由/storage/ws/文件/Canvas/音频/Observer/拖放);`lib/browser` + GFM;`web.client_embed`;示例 [browser-hello](examples/browser-hello/) · [browser-app](examples/browser-app/) · [browser-media](examples/browser-media/) · [web-client-site](examples/web-client-site/)([ADR 0002](doc/adr/0002-browser-marqdo-wasm.md) · [D](doc/roadmap/browser-wasm-d.md) · [E](doc/roadmap/browser-wasm-e.md) · [F](doc/roadmap/browser-wasm-f.md))
|
||
- 选型:[ADR 0001 — Rust](doc/adr/0001-implementation-language.md) · [ADR 0002 — 浏览器 WASM](doc/adr/0002-browser-marqdo-wasm.md)(C0–C5 完结,见 [roadmap/browser-wasm.md](doc/roadmap/browser-wasm.md))· [ADR 0003 — 异步效应](doc/adr/0003-browser-async-effects.md)
|
||
|
||
### 如何使用最新 Marqdo(v0.3.7)
|
||
|
||
```bash
|
||
# 1) 源码安装(跟 tag 或 main)
|
||
git clone https://github.com/cflmy/marqdo.git && cd marqdo
|
||
git checkout v0.3.7 # 或留在 main
|
||
cargo build --release
|
||
export PATH="$PWD/target/release:$PATH"
|
||
marqdo version
|
||
marqdo version --check
|
||
|
||
# 2) 跑解释器 / 文档站 / catalog
|
||
marqdo run tests/structure/hello.mq.md
|
||
marqdo run tests/structure/hello.mq.md --backend bytecode
|
||
marqdo view public --no-open
|
||
marqdo debug public --no-open
|
||
marqdo catalog public -o .marqdo
|
||
|
||
# 3) 安装官方扩展(Release 用户:无需本机 Rust)
|
||
marqdo ext add web # 或:网页 — 自动下载 L1 + 预编译 native
|
||
marqdo ext add agent # 或:智能体
|
||
marqdo ext add quantum # 或:量子
|
||
marqdo ext add linalg # 或:线性代数
|
||
marqdo ext add llm # 或:大模型(纯 .mq.md)
|
||
# 开发者也可:cargo build --release -p marqdo_plugin_* 后在本机 target/ 安装
|
||
# 离线:解压 Windows zip(已含 ext/native)或手动放下 native zip;MARQDO_EXT_NO_DOWNLOAD=1
|
||
|
||
# 4) 动态站示例(扩展装好后)
|
||
marqdo run examples/marqdo-blog/index.mq.md
|
||
# 浏览器打开终端打印的 listen 地址;/favicon.ico 与 logo 装配见 W8
|
||
|
||
# 5) 浏览器 WASM(可选)
|
||
marqdo wasm build
|
||
# → dist/wasm/ … 见 examples/browser-hello/
|
||
|
||
# 6) Windows:也可从 GitHub Releases 下载 exe / zip / vsix
|
||
# https://github.com/cflmy/marqdo/releases/tag/v0.3.7
|
||
```
|
||
|
||
开发期也可用 `cargo run -- …` 代替已安装的 `marqdo`:
|
||
|
||
```bash
|
||
cargo run -- run tests/structure/hello.mq.md
|
||
cargo run -- view public --no-open
|
||
cargo run -- view output public -o public
|
||
powershell -File ./scripts/build-public.ps1
|
||
```
|
||
|
||
**发布包(GitHub Releases)**:单独二进制 **已内置**官方 `lib/`(`import …:lib/…` 可直接导入)。仍提供带 `lib/` 的 zip 便于覆盖或离线分发。**扩展库**用 `marqdo ext add …` 安装(见 [CHANGELOG](CHANGELOG.md) 与 [ext-cli.md](doc/design/ext-cli.md));原生 `.so`/`.dll` 需本地编译或从带 `native/` 的安装目录解析。
|
||
|
||
文档:用户站 [public/](public/) · 设计 [doc/](doc/) · OKF / catalog [catalog-cli.md](doc/design/catalog-cli.md) · 调试 [view-debug.md](doc/design/view-debug.md) · 变更 [CHANGELOG.md](CHANGELOG.md)
|
||
---
|
||
|
||
## 命名
|
||
|
||
**Marqdo** = Marq(Markdown)+ do(执行)
|
||
|
||
## 许可
|
||
|
||
[Apache License 2.0](LICENSE)
|