SiMolt Design Design

Alibaba Cloud Feitian Lab UI Component Library - Monorepo Version

Deploy Docs

简体中文 | English

📚 Documentation

Online Documentation: https://sparkdesign.agentscope.io/

📦 Packages

Package	Path	Description
@simolt/design	packages/spark-design	Core design system component library, enhanced UI components based on Ant Design
@simolt/chat	packages/spark-chat	LLM conversation component library for building AI chat experiences

🚀 Quick Start

Installation

# Using pnpm (recommended)
pnpm install

Development

# Start spark-design dev server
pnpm run start:spark-design

# Start spark-chat dev server
pnpm run start:spark-chat

Build

# Build all packages
pnpm run build

# Build spark-design only
pnpm run build:spark-design

# Build spark-chat only
pnpm run build:spark-chat

# Build documentation
cd packages/spark-design
pnpm run docs:build

# Build GitHub Pages version
pnpm run docs:build:gh

📖 Documentation Deployment

Documentation is configured to automatically deploy to GitHub Pages.

• Quick Guide: DEPLOY_QUICKSTART.md
• Detailed Documentation: GITHUB_PAGES_SETUP.md

Documentation is automatically built and deployed on every push to the main branch.

🏗️ Monorepo Structure

simolt-design/
├── packages/
│   ├── spark-design/              # Core UI component library
│   │   ├── src/
│   │   │   ├── antd/              # Ant Design theme config
│   │   │   ├── components/        # UI components
│   │   │   │   ├── commonComponents/   # Common components
│   │   │   │   └── mobileComponents/   # Mobile components
│   │   │   ├── hooks/             # Shared hooks
│   │   │   ├── libs/              # Utility functions
│   │   │   └── i18n/              # Internationalization
│   │   ├── docs/                  # Documentation source
│   │   └── package.json
│   │
│   └── spark-chat/                # LLM conversation library
│       ├── components/
│       │   ├── AGUI/              # AGUI components
│       │   ├── Bubble/            # Message bubble
│       │   ├── Sender/            # Message sender
│       │   ├── Markdown/          # Markdown renderer
│       │   ├── Mermaid/           # Diagram renderer
│       │   ├── Conversations/     # Conversation list
│       │   ├── ChatAnywhere/      # Ready-to-use chat container
│       │   └── ...
│       ├── docs/                  # Documentation source
│       └── package.json
│
├── .github/
│   └── workflows/
│       └── deploy-docs.yml        # GitHub Actions config
├── package.json                   # Root config
└── pnpm-lock.yaml

🔧 Tech Stack

• Build Tool: Father
• Documentation: Dumi
• Package Manager: pnpm
• UI Framework: Ant Design 5
• Styling: Tailwind CSS + antd-style
• Code Quality: ESLint + Stylelint + Prettier + Husky

✨ Core Features

@simolt/design

• 🎨 Custom theme system based on Ant Design 5
• 🔧 Enhanced UI components (Button, Modal, Select, etc.)
• 📱 Mobile component support
• 🎯 Custom icon system (@simolt/icons)
• 🌐 Internationalization support

@simolt/chat

• 🤖 Ready-to-use LLM conversation experience
• 📝 Markdown rendering (with math formulas and code highlighting)
• 🎨 Extensible card component system
• 📊 Mermaid diagram support
• 🔄 Streaming response support
• 🎙️ Voice input support

📝 Development Guidelines

See rule files in .cursor/rules/ directory:

• mastergo.mdc - MasterGo data processing rules
• commonComponents.mdc - Standard component identification rules

🤝 Contributing

Contributions are welcome! Please ensure:

1. Follow existing code style
2. Add necessary tests
3. Update relevant documentation

📄 License

• spark-design: MIT
• spark-chat: Apache-2.0

🔗 Links

• Online Documentation
• GitHub Repository
• Issue Tracker
• Alibaba Cloud Bailian