| name | write-juejin-posts |
| description | 编写掘金风格的技术博客文章。当用户要求撰写掘金文章、博客文章、技术分享文、posts 目录下的文档、或提及"掘金"关键词时使用此技能。约束 YAML 元数据、摘要格式、标题编号、代码块语言、表格对齐等行文规范。 |
掘金风格技术博客编写规范
1. 文件位置与命名
- 默认目录：
docs/ruan-cat-notes/docs/posts/
- 目录命名格式：
YYYY-M-D-英文短横杠描述/index.md
- 示例：
2026-3-17-use-public-hoist-pattern-in-npmrc/index.md
2. YAML Frontmatter 规范
2.1. 必需字段
---
juejin: TODO 编写完内容就可以直接发文
desc: 不超过100字的摘要文本，避免空格以增加信息密度
---
2.2. 可选字段
---
title: "文章标题"
date: YYYY-MM-DD
categories: ["分类1", "分类2"]
tags: ["标签1", "标签2"]
---
2.3. juejin 字段规则
- 新建文档：必须使用
juejin: TODO 编写完内容就可以直接发文
- 已有文档：禁止修改
juejin 字段的值
2.4. desc 字段规则
- 总长度不超过 100 个字符（含标点）
- 为增加信息密度，应尽量避免空格
- 作为掘金文章的 SEO 摘要使用
3. 正文结构模板
# 文章标题
> **摘要**：
>
> 摘要正文。此处不受 desc 的 100 字和去空格限制，可以更详细地描述文章内容。
> **AI 协助编写的博客文章**：
>
> 这篇文章有参与 AI 协助的。使用了 AI 润色文章。
## 1. 第一个章节
正文内容……
### 1.1. 子章节
正文内容……
## 2. 第二个章节
正文内容……
## 3. 总结
总结内容……
4. 格式规则
4.1. 标题编号
- 二级标题：
## 1. 标题、## 2. 标题
- 三级标题：
### 1.1. 标题、### 2.1. 标题
- 必须维护正确的编号顺序
4.2. 表格对齐
所有表格必须使用居中对齐格式：
| 列 A | 列 B | 列 C |
| :--: | :--: | :--: |
| 值 1 | 值 2 | 值 3 |
4.3. 代码块语言标记
- 日志信息：
log
- JavaScript：
js
- TypeScript：
typescript
- 终端命令：
bash
- 配置文件：
json、yaml、ini 等对应语言
- Vue 组件片段：
vue，且必须包含 <template> 标签
4.4. 代码注释
使用 JSDoc 格式，不使用双斜线注释：
function example() {}
5. 行文风格
- 语言：简体中文
- 语气：第一人称叙事，口语化但不随意
- 结构：问题现象 → 原因分析 → 解决方案
- 加粗：用于强调关键概念和结论
- 链接：关键技术术语和工具首次出现时附上官方链接
- 总结：文章末尾应有总结或反思段落
6. 参考文章
编写时参考 docs/ruan-cat-notes/docs/posts/ 目录下的已有文章风格。
