playbook/rulesets/markdown/index.md

34 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Markdown 代理规则集
本规则集定义 AI/自动化代理在处理 Markdown`.md`)文件时必须遵守的核心约束。
## 代理工作原则(铁律)
1. 只调整代码块与行内代码;不改写正文内容
2. 不改变标题层级、列表结构、段落顺序
3. 不引入新工具/格式化链路,除非明确要求
## Markdown 代码格式约定(不可违反)
### 代码块
- 统一使用围栏代码块(```lang
- 语言标识尽量准确:`tsl`/`cpp`/`python`/`bash`/`json` 等
- 仅做必要的排版修复;不改变代码语义
### 工具
- 优先使用 Prettier仓库已固定配置/脚本)
- 不引入新的 Markdown 格式化依赖
- `markdownlint` 如需启用,由目标项目自行增加;不属于本规则集默认部署内容
### 行内代码
- 用反引号包裹命令、路径、关键字或短代码
## 适用范围
- 本规则集仅适用于 Markdown 格式整理任务(代码块格式化、语言标识补全等)
- 内容更新任务(如维护 memory-bank、编写 Plan、更新文档正文按对应任务类型的规则执行
- 涉及代码内容时,遵循对应语言的 `.agents` 规则