关于 markdown-formatting
用于编写 Markdown 文档的格式规范,涵盖代码围栏、列表、表格、标题和分隔线。适合需要统一文档格式并使用 Torchlight 代码块标记的作者。
主要功能
- 01标题与章节间距规范
- 02Torchlight 代码块标记
- 03代码围栏语言标签
- 04列表与表格约定
- 05水平分隔线规范
适用场景
- 01整理文档页面格式
- 02添加语法高亮代码示例
- 03统一列表和表格格式
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ naykel76/ skills-and-guidelines --skill markdown-formatting安装后在 Claude Code 中输入/markdown-formatting确认已加载。
详细介绍
通用
- 除非特别要求,否则不添加目录。
- 不要在句中用破折号或冒号连接两个想法。另起一句,或使用连接词(如“因为”“所以”)并用逗号连接。
代码块
所有代码块都必须包含语言标签和 Torchlight 标志。
| 标志 | 说明 |
|---|---|
+code | 仅源代码(语法高亮) |
+demo | 预览 + 代码(始终显示) |
+demo-folded | 预览 + 代码 + 可折叠 |
还存在其他标志(+preview、+collapse、output),但不太常用。仅在收到要求时使用。
语言标签
| 用途 | 标签 |
|---|---|
| 目录树、Shell 命令 | ```bash +code |
| Blade 模板 | ```html +code-blade |
Demo-Folded 属性
使用 +demo-folded 时,请有意设置演示属性:
class="..."— 外层演示容器样式preview-class="..."— 仅用于预览的布局或样式
示例开标签:
```html +demo-folded class="bx" preview-class="grid gap lg:cols-3"
<div class="example">Content here</div>
水平分隔线
在较长文档中,如果不适合使用 --- 主题分隔符,请使用 80 个连字符作为视觉分隔符:
--------------------------------------------------------------------------------
列表
- 无序列表使用连字符
- - 有序步骤使用
1.2. - 嵌套项缩进 4 个空格
表格
使用标准 GitHub Flavored Markdown。保持列分隔符对齐。
| 列 | 类型 | 可为空 | 默认值 |
|---|---|---|---|
| id | bigint | 否 | AUTO |
| name | varchar(255) | 否 | - |
Lint
- 标题、代码块和列表前后各空一行
- 不要在行尾添加空格
- 各部分之间空一行,不要空两行
评论
支持 Markdown