with one click
docs-format
操作Markdown文档时使用。文档格式技能,遵循量潮科技文档格式标准,用于生成或检查规范文档。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Menu
操作Markdown文档时使用。文档格式技能,遵循量潮科技文档格式标准,用于生成或检查规范文档。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | docs-format |
| description | 操作Markdown文档时使用。文档格式技能,遵循量潮科技文档格式标准,用于生成或检查规范文档。 |
主仓库 CHANGELOG 中涉及子模块更新的条目,必须标注目标 tag 版本号:
### 变更
- 更新子模块:qtadmin(v0.2.0)、tutorial(v0.0.3)、roadmap(v0.0.2)
版本号来源于子模块自身的 git tag。未发布的子模块用 commit SHA 前 7 位代替。
遵循 量潮科技文档格式标准
# / ## / ###)分隔线(---)用于划分文档主要部分:
无序列表(-)适用于:
有序列表(1.)适用于:
避免场景:
嵌套列表:
必须标注代码语言类型:
git status
def hello():
print("Hello")
行内代码使用反引号:variable、function()、file.md
表格用于呈现多维度需对比的数据。
应使用表格的场景:
应避免的场景:
基本格式:
| 列1 | 列2 | 列3 |
|---|---|---|
| 左对齐 | 居中 | 右对齐 |
规范:
:--、:--:、--:)外部链接:[链接文本](https://example.com)
内部链接:使用相对路径 [文档](./docs/guide.md)
加粗用于强调关键词,避免过度使用。
应使用加粗的场景:
应避免的场景:
块引用:> 使用块引用标注重要提示、警告或引用内容
中文文档使用中文引号:
应使用引号的场景:
应避免的场景:
替代方案:
variable