✨ feat(markdown): add ruleset and sync support
This commit is contained in:
@@ -32,3 +32,7 @@
|
||||
- 代码风格:`python/style_guide.md`
|
||||
- 工具链:`python/tooling.md`
|
||||
- 配置清单:`python/configuration.md`
|
||||
|
||||
## Markdown(markdown)
|
||||
|
||||
- 代码块与行内代码格式:`markdown/index.md`
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
# Markdown 规范(仅代码格式化)
|
||||
|
||||
本目录只规范 Markdown 中**代码块**与**行内代码**的格式化规则;正文、标题、列表与段落结构保持原样,除非明确要求调整。
|
||||
|
||||
## 适用范围
|
||||
|
||||
- `.md` 文件
|
||||
|
||||
## 代码块
|
||||
|
||||
- 统一使用围栏代码块(```lang)
|
||||
- 语言标识尽量准确(`tsl`/`cpp`/`python`/`bash`/`json` 等)
|
||||
- 仅做必要的排版修复;不改变代码语义
|
||||
|
||||
## 行内代码
|
||||
|
||||
- 用反引号包裹命令、路径、关键字或短代码
|
||||
|
||||
## 格式化工具
|
||||
|
||||
- 优先使用仓库已固定的工具配置
|
||||
- 若存在 Prettier 配置,使用项目脚本或 `npx prettier -w <files...>`
|
||||
- 不引入新的 Markdown 格式化工具
|
||||
|
||||
## 关联规则
|
||||
|
||||
- 代码内容遵循对应语言的 `.agents/<lang>/index.md`
|
||||
Reference in New Issue
Block a user