如何使用Cursor Rule MDC文件
提示:为了充分利用Cursor Rule的能力,请将以下MDC文件添加到你的项目中:
文件名:
blog-writing-guide.mdc
保存位置:项目根目录下的
.cursor
文件夹内使用方法:添加此文件后,Cursor编辑器将自动识别并应用这些规则,为你的博客创作提供智能辅助和格式化建议。当你创建新的博客文章时,编辑器会根据这些规则提供相应的提示和自动完成功能。
md
# 博客撰写指南
## 博客文章格式规范
- Markdown 文件需放置在 `src/content/posts/` 目录下
- 文件名使用短横线连接,例如:`my-blog-post.md`
## 文章 Frontmatter 规范
---
title: 文章标题
date: YYYY-MM-DD # 发布日期,格式为 YYYY-MM-DD
lastMod: YYYY-MM-DDThh:mm:ss.sssZ # 最后修改日期,ISO格式
summary: 文章摘要,不超过200字
category: 分类 # 单一分类:开发、教程、笔记、随想等
tags: [标签1, 标签2] # 标签列表,可多选
sticky: 数字 # 可选,置顶文章的排序优先级,数字越大越靠前
---
## 内容规范
### 标题层级规范
- 使用 `##` 作为文章一级标题(因为 `#` 已被文章标题占用)
- 层级不要超过四级(不要使用 `#####` 或更多)
- 标题间保持层级关系,不要跳级(如从 `##` 直接到 `####`)
### 图片使用规范
- 图片文件建议存放在 `src/assets/images/posts/` 目录下
- 图片尺寸控制在合理范围内,避免过大文件
- 使用相对路径引用图片

### 代码块规范
- 指定代码语言以获得语法高亮
- TypeScript/JavaScript 代码使用 JSDoc 风格注释
/\*\*
* 函数描述
* @param {string} param1 - 参数描述
* @returns {boolean} 返回值描述
\*/
function example(param1: string): boolean {
return true;
}
## 博客撰写技巧
### 内容组织
1. **开头吸引注意**:用引人入胜的开头吸引读者
2. **问题-解决方案结构**:先描述问题,再提供解决方案
3. **小节与段落**:将内容分成小节,每个段落聚焦一个观点
4. **总结归纳**:文章最后做简要总结,强化核心观点
### 风格建议
1. **清晰简洁**:使用简洁的语言表达复杂概念
2. **实例说明**:用具体例子解释抽象概念
3. **视觉辅助**:适当使用图片、图表和代码示例
4. **一致性**:保持术语和格式一致
### SEO优化提示
1. **关键词使用**:在标题、摘要和正文中自然使用关键词
2. **内部链接**:链接到网站内其他相关内容
3. **元描述**:使用summary字段提供有吸引力的摘要
4. **可读性**:使用小标题、列表和短段落提高可读性
## 发布前检查清单
- [ ] 标题简洁明了且能够吸引读者
- [ ] Frontmatter信息完整正确
- [ ] 文章结构清晰,有明确的开头、主体和结尾
- [ ] 检查拼写和语法错误
- [ ] 代码示例已经测试并可正常工作
- [ ] 图片正确显示且有合适的alt文本
- [ ] 内部链接和外部链接都可正常访问
- [ ] 文章内容符合网站整体风格和受众期望
什么是Cursor Rule
Cursor Rule是一种用于定义和规范化博客内容创作的指导规则集。它提供了一系列标准和最佳实践,确保网站上的所有内容保持一致的质量和格式。在Astro项目中,这些规则通常以.mdc
文件形式存在,作为开发者的参考指南。
使用Cursor Rule的主要优势:
- 内容一致性 - 确保所有博客文章遵循相同的格式和结构标准
- 提高效率 - 减少决策时间,让创作者专注于内容而非格式
- 质量保证 - 通过预设的检查项确保内容质量
- 团队协作 - 为多作者环境提供统一标准