使用说明
ikas主题MCP
ikas是一个将开发者门户文档转换为模型上下文协议(MCP)格式的综合项目。该项目将使人工智能助理能够轻松访问主题开发文档,并更有效地帮助开发人员。
📋 内容
🎯 关于我们
ikas是电子商务商店的现代灵活主题开发平台。该项目以MCP格式提供ikas官方开发者门户网站上的所有文档,人工智能助理旨在更有效和准确地协助主题开发过程。
什么是iks主题开发?
ikas 主题由 React 组件组成,商店所有者可以在视觉上进行自定义。开发人员创建模块化组件(拼图块),而不是编码完整的页面,商店所有者可以在他们想要的页面上使用它们。
主题开发过程
- 在 Partner Interface 中创建帐户创建开发者帐户和测试商店
- 创建主题:
npx create-ikas-theme@latest使用命令创建主题模板 - 组件开发定义 React 组件和 prop 类型
- 在主题编辑器中测试不要在视觉上测试组件
- 发布向店主介绍主题
✨ 产品特点
- 📚 全面的文档Ikas涵盖主题开发过程的所有阶段
- 🤖 MCP兼容Model Context Protocol 格式
- 🎨 20+支撑类型Rehberi所有 prop 类型的详细说明和代码示例
- 🚀 一步一步的指南指南:分步说明创建第一个组件的过程
- ⚙️ 主题设置颜色、字体和常规设置文档
- 🌍 多语言支持主题翻译和本地化指南
- 💡 实际案例实际使用场景和最佳实践
- 🔗 API 参考相关API模型和类的链接
📁 项目结构
ikasthememcp/
├── theme/
│ ├── getting-started/ # Başlangıç kılavuzları
│ │ ├── introduction.md # Giriş ve genel bakış
│ │ ├── creating-your-first-component.md
│ │ ├── creating-your-second-component.md
│ │ ├── editor.md # Tema editörü kullanımı
│ │ └── summary.md
│ │
│ ├── prop-types/ # Prop type dokümantasyonları
│ │ ├── introduction.md # Prop type'lar hakkında genel bilgi
│ │ ├── text.md # Metin prop type'ı
│ │ ├── rich-text.md # Zengin metin prop type'ı
│ │ ├── boolean.md # Boolean prop type'ı
│ │ ├── image.md # Görsel prop type'ı
│ │ ├── image-list.md # Görsel listesi prop type'ı
│ │ ├── link.md # Link prop type'ı
│ │ ├── link-list.md # Link listesi prop type'ı
│ │ ├── product.md # Ürün prop type'ı
│ │ ├── product-list.md # Ürün listesi prop type'ı
│ │ ├── attribute.md # Özellik prop type'ı
│ │ ├── attribute-list.md # Özellik listesi prop type'ı
│ │ ├── brand.md # Marka prop type'ı
│ │ ├── brand-list.md # Marka listesi prop type'ı
│ │ ├── category.md # Kategori prop type'ı
│ │ ├── category-list.md # Kategori listesi prop type'ı
│ │ ├── color.md # Renk prop type'ı
│ │ ├── component.md # Bileşen prop type'ı
│ │ ├── component-list.md # Bileşen listesi prop type'ı
│ │ ├── blog.md # Blog prop type'ı
│ │ ├── blog-list.md # Blog listesi prop type'ı
│ │ ├── blog-category.md # Blog kategori prop type'ı
│ │ ├── blog-category-list.md # Blog kategori listesi prop type'ı
│ │ ├── number-select-slider.md # Sayı seçim kaydırıcısı prop type'ı
│ │ └── custom-data.md # Özel veri tipleri
│ │
│ ├── theme-settings/ # Tema ayarları dokümantasyonu
│ │ ├── introduction.md # Tema ayarları giriş
│ │ ├── generic-settings.md # Genel ayarlar
│ │ ├── colors.md # Renk ayarları
│ │ ├── fonts.md # Font ayarları
│ │ └── translations.md # Çeviri ayarları
│ │
│ └── translations.md # Çeviri ve lokalizasyon rehberi
│
└── README.md # Bu dosya
📖 文档内容
入门指南
入门指南可帮助新主题开发人员迈出第一步:
- 介绍关于 ikas 主题开发、技术堆栈和安装的一般信息
- 创建第一个组件创建简单组件的步骤
- 创建第二个组件: 具有更高级功能的组件
- 编辑使用主题编辑器指南
- 摘要:学到的概述
道具类型
包含每种属性类型的详细文档。 20+ 不同类型 prop 包括:
Temel支柱类型
- 文本简单的文本输入
- 富文本样式可应用的丰富文本编辑器
- 布尔是/否选项
- 颜色颜色选择器
Medya道具类型
- 图像视觉上传和显示(具有Next.js图像优化)
- 图像列表多视觉管理
导航道具类型。
- 链接导航链接(内部和外部链接)
- 链接列表多链接管理和菜单结构
E-ticaret支柱类型
- 产品产品选择与展示
- 产品列表显示产品列表
- 类别类别选择
- 类别列表类别列表
- 品牌品牌选择
- 品牌列表品牌列表
- 属性产品特点:
- 属性列表产品特性列表
博客道具类型
- 博客博客文章选择
- 博客列表博客文章列表
- 博客类别博客类别选择
- 博客分类列表博客类别列表
高级Prop Types
- 组件: 组件参考
- 元件清单组件列表
- 数字选择滑块数字选择滑块
- 自定义数据类型Enum、Object 和其他自定义数据类型
每个 prop type 文档包括:
- Prop 类型的目的和使用场景
- 详细代码示例
- 相关API模型和类
- 最佳实践建议
- 特殊使用情况
主题设置
主题设置是可用于所有组件的全局设置:
- 常规设置一般主题设置
- 颜色主题调色板和颜色管理
- 字体字体选择和管理
- 翻译主题翻译和语言设置
全部设置 settings 通过 prop 传递到组件,并且 IkasThemeJsonSettings 是班级的一个例子。
翻译
多语言支持的全面指南:
- 创建本地文件:
public/locales文件夹结构 - 使用翻译挂钩在组件中使用翻译
- 可变翻译动态值转换
- 开发过程中更改语言:
next.config.js配置 - 转换默认 Prop 值多语言的默认值
🚀 使用
此 MCP 服务器允许人工智能助理访问主题开发文档。当配置为 MCP 服务器时,助理可以访问以下信息:
- ✅ 主题开发入门指南
- ✅ 所有属性类型及其详细用法
- ✅ 组件构建示例和最佳实践
- ✅ 主题设置和配置
- ✅ 多语言支持和本地化
- ✅ API 参考和模型文档
MCP 服务器配置
您可以在配置 MCP 服务器时使用此项目作为资源。由于文档文件是标准Markdown格式,因此可以轻松解析并按照MCP协议提供。
🛠 技术
IKS主题开发是基于以下技术:
- Next.js -React框架(SSR、路由、图像优化)
- TypeScript 类型 安全 JavaScript
- MobX Reactive State 管理
- 反应 UI 图书馆
- CSS模块 基于组件的风格管理
要求
- Node.js 16.x 或更高
- 纱线 软件包管理器(目前必需)
- ikis 合作伙伴账户 为了开发主题
🤝 找不到贡献
该项目旨在将 ikas 开发者门户网站上的文档转换为 MCP 格式。我们期待您对文档更新、改进和新内容的贡献。
贡献步骤
- 更新文档或添加新内容
- 保留Markdown格式
- 测试代码示例(如果可能)
- 提交您的更改
- 创建 Pull Request
文档标准
- 使用Markdown格式
- 用语言标签标记代码示例
- 添加相关 API 引用的链接
- 分享实例和用例
📝 重要说明
- ⚠️ 本文档由 无头主题 包括其特性
- 🆕 享受工作室! (新主题开发环境)即将公布
- 🧪 主题开发仍 测试版 处于阶段
- 📦 目前只有 纱线 包管理器支持
🔗 相关资源
官方文件
技术文件
社区
📄 许可证
该项目旨在以MCP格式提供iOS开发者门户文档。文档内容属于 ikas。
不本文档不断更新。获取最新信息 ikas 开发 门户拜访他。
有问题吗? Discord 社区 加入或 GitHub问题 给我反馈。