awesome-cursorrules-zh: Instructions file for Claude Code

CLAUDE.md

本文件为 Claude Code CLI 提供项目配置。面向所有 AI 协作工具的通用指南见 AGENTS.md。

项目概述

awesome-cursorrules-zh — Cursor AI 编辑器 .cursorrules 规则集合中文版。

• 132 个规则文件，覆盖 32 个技术领域
• VitePress 双语文档站（中 / 英）：https://awesome-cursorrules-zh.js.org/
• 规则资产与文档站点同构，均位于 docs/ 下（顶层没有 rules/、zh/、en/ 目录）

技术栈

技术	版本	用途	声明位置
Node.js	>=20.0.0	运行时	根 package.json
markdownlint-cli2	^0.23.2	Markdown 格式检查	根 package.json
VitePress	^1.6.4	静态站点生成	docs/package.json
UnoCSS	^66.6.8	原子化样式	docs/package.json
Mermaid	^11.12.2	图表渲染	docs/package.json

目录结构

awesome-cursorrules-zh/
├── docs/                       # 文档站 + 规则资产（同构）
│   ├── .vitepress/             # VitePress 配置、主题组件、站点数据
│   ├── zh/                     # 中文文档
│   ├── en/                     # 英文文档
│   ├── rules/                  # 规则资产源：32 个领域目录，共 132 个 .cursorrules
│   ├── scripts/                # sync-site-facts.mjs（构建前同步站点事实数据）
│   ├── public/                 # 静态资源（字体、logo、og-image）
│   ├── index.md                # 站点首页
│   ├── package.json            # docs 子项目依赖与脚本
│   └── uno.config.ts
├── tests/                      # node:test 测试（site-ia.test.mjs：站点 IA 一致性）
├── .github/workflows/          # ci-docs.yml（构建验证）+ docs-pages.yml（Pages 部署）
├── AGENTS.md                   # 跨工具 AI 协作指南
├── CONTRIBUTING.md             # 贡献指南
├── DESIGN.md / PRODUCT.md      # 设计决策与产品定位
├── CHANGELOG.md
└── package.json                # 根：编排 lint / test / docs 构建

常用命令

# 开发与构建
npm run docs:dev        # 启动开发服务器（内部会先 sync 站点事实数据）
npm run docs:build      # 构建静态站点
npm run docs:preview    # 预览构建结果

# 质量检查
npm run lint            # Markdown 格式检查（markdownlint-cli2）
npm run lint:fix        # 自动修复格式问题
npm test                # 运行 tests/site-ia.test.mjs

# 完整校验（lint + test + docs 构建）
npm run check

注意：docs:dev / docs:build 内部执行 cd docs && npm run <script>。docs/package.json 中的 dev 与 build 都会先运行 npm run sync（docs/scripts/sync-site-facts.mjs），确保站点展示的数据与规则资产一致。