Files
marqdo/doc/tutorial
cflmyandCursor d7924ea8c7 Add Marqdo Chinese syntax tutorial under doc/tutorial/
13 chapters plus a README index covering syntax, variables, functions,
control flow, collections, objects/inheritance, modules and the CLI.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-08-24 14:45:26 +08:00
..

Marqdo 语法教程

代码即文档,文档即代码。 Marqdo 把 Markdown 的标记当作编程语法:同一个 .mq.md 文件既是给人读的文稿,也是给机器跑的程序。

本教程面向所有读者——从没写过代码的文档作者,到熟悉 Python 的工程师。每章都配有可直接运行的完整示例。

目录

第一部分 · 入门

章节 内容 你能学会什么
第 1 章:Marqdo 是什么 理念、安装、第一个程序、运行 写出并运行你的第一个 .mq.md 程序
第 2 章:基本语法 文件结构、注释、标识符、字面量 看懂 .mq.md 里哪些是代码、哪些是注释

第二部分 · 变量与数据

章节 内容 你能学会什么
第 3 章:变量与赋值 绑定、变量引用、字符串 存取值,拼接文本
第 4 章:输出与输入 print / 打印、input / 输入 与用户交互
第 5 章:运算符与比较 算术、比较、逻辑 计算与判断

第三部分 · 流程控制

章节 内容 你能学会什么
第 6 章:函数 定义、参数、返回值、函数结束 封装可复用逻辑
第 7 章:条件分支 1. 2. 分支、else 让程序根据条件走不同路线
第 8 章:循环 - 遍历、- while 重复执行

第四部分 · 数据集合

章节 内容 你能学会什么
第 9 章:集合(表格) 列表、字典、记录、脚注取元 用 Markdown 表格组织数据

第五部分 · 面向对象与模块

章节 内容 你能学会什么
第 10 章:对象与方法 # 类型、构造、方法、继承 面向对象编程
第 11 章:模块与导入 frontmatter、import、库路径、短名 组织大型项目

第六部分 · 进阶

章节 内容 你能学会什么
第 12 章:标准库 内置函数、lib/ 模块 直接使用官方能力
第 13 章:命令行工具 run / view / debug / catalog 运行、浏览、调试、发布

快速示例

一个完整的 Marqdo 程序长这样:

# main

> 问候 谁=World

## 问候
    + `谁`

> print text=Hello, `谁`!

---

## 加一
    + `n`

**n + 1**
  • # main —— 入口
  • > 问候 谁=World —— 调用函数(具名参数)
  • ## 问候 + + 谁`` —— 定义函数及其参数
  • > print text=… —— 输出(副作用,是普通函数)
  • **n + 1** —— 返回值
  • 单独一行 --- —— 结束函数体

运行方式

marqdo run 文件.mq.md

更多运行、浏览、调试、发布方式见 第 13 章。

提示:语法宪法与精确定义见 doc/design/markdown-mapping.md;本教程是它的通俗讲解版。