Skip to content

README.md

Latest commit

 

History

History
143 lines (87 loc) · 5.17 KB

README.md

File metadata and controls

143 lines (87 loc) · 5.17 KB

Ant Design X Skill

Intelligent skill library specially designed for Ant Design X

CI status NPM version NPM downloads bundle size Ant Design

Changelog · Report Bug · Feature Request · English · 中文

✨ Core Features

  • 🤖 Intelligent Development Experience: Code generation and optimization suggestions based on best practices, with AI assisting your development
  • ⚡ Significant Efficiency Boost: Reduce repetitive work and accelerate Ant Design X project development
  • 🛡 Quality Assurance: Strictly follow Ant Design X design specifications to ensure code quality and consistency
  • 🎯 Full Scenario Coverage: Cover common AI application scenarios like conversation components, data requests, state management, and Markdown rendering
  • 🔧 Multi-IDE Support: Support mainstream AI IDEs like Claude Code, CodeFuse, and Cursor

📦 Installation

One-click Installation (Recommended)

Supports mainstream AI IDEs, complete installation with a single command:

# Install skill library globally
npm i -g @ant-design/x-skill

# Smart registration to current IDE
npx x-skill

Claude Code Integration

Plugin Marketplace Installation (Officially Recommended)

Step 1: Register Plugin Marketplace

Execute the following command in Claude Code to add this repository as a plugin source:

/plugin marketplace add ant-design/x/blob/main/packages/x-skill/

Step 2: Select and Install Skills

Install the skills included in the x-skill package.

Click Install now to complete the installation.

Quick Installation

You can also directly install the complete skill package through commands:

/plugin install x-sdk-skills@x-agent-skills

Manual Installation

Suitable for scenarios requiring customized configuration:

  • Global Installation: Copy skill files to the ~/.claude/skills directory, available for all projects
  • Project Installation: Copy skill files to the .claude/skills directory in the project root, available only for the current project

🔧 Included Skills

use-x-chat

Conversation SDK usage guide to help you quickly integrate Ant Design X conversation features.

x-chat-provider

Chat data flow management, providing efficient data stream processing solutions.

x-request

Network request best practices, optimizing API calls and data processing.

x-markdown

Markdown rendering guide for streaming output, component mapping, plugins, and themes.

🎯 Applicable Scenarios

  • 🚀 New Project Startup: Quickly set up Ant Design X project framework with complete configuration and best practices
  • ⚙️ Feature Development: Get best practices and code examples for component usage, rendering, and integration to accelerate feature implementation
  • 🔍 Problem Troubleshooting: Intelligent diagnosis and resolution of common development issues with professional solutions
  • 📈 Performance Optimization: Get professional advice for performance tuning to improve application performance

🛠 Development

Local Development

# Clone the project
git clone https://github.com/ant-design/x.git

# Enter the skill directory
cd packages/x-skill

# Install dependencies
npm install

# Development mode
npm run dev

Build

# Build the project
npm run build

# Run tests
npm test

🤝 How to Contribute

We welcome all forms of contribution, including but not limited to:

Before participating, please read our Contributor Guide.

📞 Community Support

If you encounter problems during use, you can seek help through the following channels:

  1. GitHub Discussions - Discussions and Q&A
  2. GitHub Issues - Bug reports and feature requests

📄 License

MIT