用途:Backlog 记法是 Nulab Backlog 中每个项目可选的两种文本格式规则之一(另一种为 Markdown,且是新项目默认)。本参考仅覆盖 Backlog 记法,用于在采用该规则的项目中正确书写文本。
主要能力:支持标题(* H1 至 **** H4)、加粗 ''text''、斜体 '''text'''、删除线 %%text%%、颜色 &color(red) { text }、列表(- 与 +,用 -- 或 ++ 嵌套)、清单(仅课题描述)、链接 [[url]] 与 [[label>url]]、课题自动链接、引用、代码块 {code}...{/code}(可指定语言)、图片 #image()、缩略图 #thumbnail()、目录 #contents、换行 &br;、转义 \,以及用 | 分隔、行尾 h 表头、~ 行头、> 合并单元格的表格。
使用方式:先确认项目规则。若用户或项目说明(AGENTS.md、CLAUDE.md)已写明则直接遵循;未写明时检查一次:bee project view -p PROJECT_KEY --json textFormattingRule,返回 backlog 用本参考,返回 markdown 则改用 Markdown。无法运行 bee 时,可请求 /api/v2/projects/PROJECT_KEY 读取 textFormattingRule,或询问用户。
限制:Backlog 记法与 Markdown 不可混用,错误语法会按字面显示;无行内代码语法,仅支持块级 {code};{quote} 不可嵌套;清单仅用于课题描述,评论和 Wiki 不支持;缩略图需小于 200KB;支持的语言包括 java、cs、js、python、ruby、perl、php、sql、html、xml、css、shell 等。