From 0e7f507efb0139302b6d7037726f9d9f58a62daf Mon Sep 17 00:00:00 2001 From: OwenYWT <103073962+OwenYWT@users.noreply.github.com> Date: Sat, 11 Apr 2026 23:56:07 +0800 Subject: [PATCH] docs(lark-doc): clarify when markdown escaping is needed (#312) * docs(lark-doc): clarify when markdown escaping is needed * docs(lark-doc): fix escaped special character code span --- skills/lark-doc/references/lark-doc-create.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/skills/lark-doc/references/lark-doc-create.md b/skills/lark-doc/references/lark-doc-create.md index 69b492569..03f437240 100644 --- a/skills/lark-doc/references/lark-doc-create.md +++ b/skills/lark-doc/references/lark-doc-create.md @@ -134,7 +134,8 @@ lark-cli docs +create --title "产品需求" --markdown ' { } | ^` +- 只有当字符会被解释为 Markdown / Lark 富文本语法时，才需要使用反斜杠转义：``* ~ ` $ [ ] < > { } | ^`` +- 普通文本中的孤立字符不要过度转义。例如 `5 * 3`、`version~1.0`、`final_trajectory` 通常应保持原样，只有像 `*斜体*`、`**粗体**`、`~~删除线~~` 这种会触发格式化的写法，想按字面量显示时才需要转义 --- @@ -657,7 +658,7 @@ $$ ## 最佳实践 - **空行分隔**：不同块类型之间用空行分隔 -- **转义字符**：特殊字符用 `\` 转义：`\*` `\~` `\`` +- **转义字符**：只有在字符会触发格式化时才用 `\` 转义。例如想输出字面量 `*斜体*` 时写成 `\*斜体\*`；但 `5 * 3`、`version~1.0`、`final_trajectory` 这类普通文本通常不需要转义 - **图片**：使用 URL，系统自动下载上传 - **分栏**：列宽总和必须为 100 - **表格选择**：简单数据用 Markdown，复杂嵌套用 ``