Skip to content

docs(lark-doc): clarify when escape is needed to prevent agent over-escaping #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
meijing0114 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(lark-doc): clarify when escape is needed to prevent agent over-escaping #216

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1a364c
docs(lark-doc): clarify when escape is needed to prevent agent over-e…
meijing0114 Apr 2, 2026
0c54e2b
fix(lark-doc): use individual code spans for escape character list
meijing0114 Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions skills/lark-doc/references/lark-doc-create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,9 @@ lark-cli docs +create --title "产品需求" --markdown '<callout emoji="💡" b

- 使用标准 Markdown 语法作为基础
- 使用自定义 XML 标签实现飞书特有功能（具体标签见各功能章节）
- 需要显示特殊字符时使用反斜杠转义：`* ~ ` $ [ ] < > { } | ^`
- 转义：仅当特殊字符会触发格式化语法时才需要反斜杠转义。支持转义的字符：`*`, `~`, `` ` ``, `$`, `[`, `]`, `<`, `>`, `{`, `}`, `|`, `^`
- 需要转义：`\*不是斜体\*`（`*...*` 会触发斜体）、`\~\~不是删除线\~\~`
- 无需转义：`5 * 3`（孤立的 `*` 不触发格式化）、`final_trajectory`（`_` 在单词中间不触发斜体）、`version~1.0`（孤立的 `~` 不触发删除线）

---

Expand Down Expand Up @@ -642,7 +644,7 @@ $$
## 最佳实践

- **空行分隔**：不同块类型之间用空行分隔
- **转义字符**：特殊字符用 `\` 转义：`\*` `\~` `\``
- **转义字符**：仅在字符会触发格式化时才转义（如 `\*text\*` 防止斜体）。普通上下文中的 `*`、`~`、`_` 等无需转义
- **图片**：使用 URL，系统自动下载上传
- **分栏**：列宽总和必须为 100
- **表格选择**：简单数据用 Markdown，复杂嵌套用 `<lark-table>`
Expand Down
Loading