✨ Project Overview

Awesome AI Pedia is a modern AI knowledge base, aimed at providing developers with comprehensive AI tool guides, best practices, and hands-on experience sharing.

🎯 Core Features

• 📚 Comprehensive Coverage — from Claude Code, Cursor, and MCP to mainstream AI directions like Agent, Skills, and Prompt Engineering
• 💡 Practical Focus — Starting from real projects, providing actionable solutions
• 🔍 Local Search — Built-in full-text search to quickly locate content
• 🌙 Dark Theme — Default dark interface, comfortable for extended reading
• 🚀 Auto Deployment — Push to master to automatically build and publish to GitHub Pages

---

📂 Knowledge Base Categories

Each category below maps to a real directory in the repo root — browse the raw Markdown directly.

🤖 AI Coding Assistants

Directory	Description
claudeCode/	Complete Claude Code usage guide: installation & configuration, common commands, Browser tool, Settings.json explained
cursor/	Cursor editor: feature details, Chinese conversation, region restrictions, menu bar customization, version management
codex/	OpenAI Codex related practices
antigravity/	Antigravity related notes
openclaw/	Openclaw related content

🔌 Ecosystem & Protocols

Directory	Description
mcp/	Model Context Protocol: Figma / Lanhu / Feishu / Playwright / Context7 / Chrome DevTools and other MCP practices
Agent/	AI Agent related content
Harness Engineering/	Prompt / Agent orchestration engineering

💬 Prompts & Rules

Directory	Description
prompt/	Prompt engineering: React + UI designer, SVG poster design, prompt best practices
rules/	AI coding rules for Next.js / Vue / NuxtJS / Flutter / Expo / Spring Boot / HTML & CSS, etc.
好的rules/	Curated collection of high-quality Rules

🛠️ Skills & Tools

Directory	Description
skills/	Skills concepts, differences from MCP, installation, custom development
常用skills/	Frequently used Skills toolkit
工具/	Collection of common utility tools

📚 Learning & Practice

Directory	Description
不可不知的Ai知识/	Essential AI knowledge for beginners
使用ai技巧/	Tips for using AI tools efficiently
开发ai应用相关问题/	Troubleshooting common issues in AI application development
部署ai/	AI application deployment strategies and practices
vibe coding/	Vibe Coding practices
vibe design/	Vibe Design practices
全栈/	Full-stack development related
Ai面试类/	AI-related interview questions and experiences
其他/	Other uncategorized content

---

🚀 Quick Start

Option 1: Use the Launch Script (Recommended)

git clone https://github.com/Awesome-AI-Pedia/Awesome-AI-Pedia.git
cd Awesome-AI-Pedia

# 首次运行需要授予执行权限
chmod +x start.sh

# 一键启动：自动检查 Node 版本、安装依赖、启动 dev server
./start.sh

🗂️ Project Structure

Awesome-AI-Pedia/
├── docs/                    # VitePress 站点入口
│   ├── .vitepress/          # 配置、主题、侧边栏生成器
│   ├── blog/                # 博客文章
│   └── index.md             # 首页
├── claudeCode/              # 各知识分类目录（会被 VitePress 收录）
├── cursor/
├── mcp/
├── skills/
├── ...                      # 其他分类目录
├── scripts/                 # 构建辅助脚本
├── .github/workflows/       # GitHub Actions 自动部署
├── start.sh                 # 一键启动脚本
└── package.json

VitePress uses srcDir: '../' to treat the entire repository root as the documentation source, and the sidebar is automatically generated by scanning docs/.vitepress/utils/sidebar.ts.

---

📞 Contact

Search for 硬核 AI 社 on WeChat and reply "加群" to join the AI discussion group and learn AI together.

• GitHub Issues: Submit an issue or suggestion
• Project homepage: https://awesome-ai-pedia.github.io/Awesome-AI-Pedia/

---