关于 md-syntax
md-syntax 是面向 Markdown 作者的编写规范技能,适用于创建和编辑文件,涵盖文档结构、代码块标注及格式要求。
主要功能
- 01代码块标注语言
- 02标题与文档结构规范
- 03不同 Markdown 样式间留空行
- 04格式化约定与 lint 指引
- 05文件末尾换行要求
适用场景
- 01创建 Markdown 文件
- 02按格式规范编辑 Markdown
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ jimweller/ clanker-skills --skill md-syntax安装后在 Claude Code 中输入/md-syntax确认已加载。
详细介绍
Markdown 编写指南
创建或编辑 Markdown 文件时,请遵循以下规则。
规则
- 代码块始终指定语言 - 使用
bash、yaml、json、text、hcl、go等。绝不使用不带语言标识的``` - 不要写 AI 垃圾内容 - 绝不使用表情符号、特殊字形或长破折号
- 使用标题,不要用粗体作为章节标题 - 使用正确的标题级别(
##、###等),不要单独一行写**粗体** - 每个文件只写一个 H1 - 文件顶部只能有一个
# 标题 - 首行应为 H1 - 文件以
# 标题开始 - 遵循格式化工具约定 - 每次写入后,PostToolUse hook 都会重新格式化 Markdown。请参阅
/md-lint,了解它会重写哪些内容,以及哪些 lint 规则无法自动修复 - 不同样式之间留空行 - 不同 Markdown 类型之间留一个空行
示例
不同样式之间留空行
不同 Markdown 类型或样式之间留一个空行。不要在不同 Markdown 样式之间留多个空行。
正确
## Heading
paragraph
- list item one
- list item two
> block quote
错误
## Heading
paragraph
- list item one
- list item two
> block quote
使用标题,不要用粗体
正确
### Heading
paragraph
错误
**heading incorrect bold**
paragraph
代码块
始终指定语言。
指定语言的正确示例
```bash
#!/bin/bash
```
未指定语言的错误示例
```
#!/bin/bash
```
末尾换行符
在文件内容的最后一行之后添加一个换行符。围栏示例无法展示这一点,因为围栏会隐藏最后一个字节。使用 tail -c 1 file.md | xxd 检查,输出必须为 0a。
评论
支持 Markdown