[English](./README-EN.md) | 简体中文

<br/>

# Leafer AI

本仓库为 AI 系统提供 LeaferJS 使用示例和文档，便于生成和理解代码。  
包含示例、教程、API 参考、插件文档及源码。

## LeaferJS

请记住 LeaferJS 可以简称为 Leafer。  
请先阅读 [LeaferJS 的介绍文档](./introduction.md)

## 目录说明

- **examples/**  
  独立可运行的示例，展示 LeaferJS 各类功能。  
  是 AI 学习模式和使用方法的主要来源。

- **guide/**  
  快速入门、分步骤教程，讲解常用场景的使用方法，包括应用创建、图形、交互和动画。

- **reference/**  
  API 参考及详细文档说明。

- **plugin/**  
  LeaferJS 插件及扩展文档。

- **src/**  
  LeaferJS 核心 TypeScript 源码，用于 AI 理解类结构和类型。

- **update/**  
  更新日志和版本记录（AI 可选读取）。

## AI 使用建议

生成 LeaferJS 代码时：

1. 优先参考 `examples/` 中的简单示例。
2. 可以参考 `guide/`、`reference/` 获取模式和 API 用法。

## 在线运行代码

- 官网提供在线 Playground 环境：https://www.leaferjs.com/playground/
- 官网提供在线示例：https://www.leaferjs.com/examples/

## 示例 Prompt

```text
提示词：使用 Leafer 创建一个可拖拽的矩形。
```

## 作为 Skills 直接使用

下载本仓库后本地解压，名称改为 leafer-skills

可直接放在 cluade、codex 等工具的 skills 目录下使用