808 B
808 B
Markdown 规范(仅代码格式化)
本目录只规范 Markdown 中代码块与行内代码的格式化规则;正文、标题、列表与段落结构保持原样,除非明确要求调整。
适用范围
.md文件
代码块
- 统一使用围栏代码块(```lang)
- 语言标识尽量准确(
tsl/cpp/python/bash/json等) - 仅做必要的排版修复;不改变代码语义
行内代码
- 用反引号包裹命令、路径、关键字或短代码
格式化工具
- 优先使用 Prettier(仓库已固定配置/脚本)
- 若存在项目脚本,优先使用
npm run format:md;否则可用npx prettier -w <files...> - 不引入新的 Markdown 格式化工具
关联规则
- 代码内容遵循对应语言的
.agents/<lang>/index.md