https://github.com/leaferjs/ai-docs

Leafer AI: Designed for training AI to learn LeaferJS.
https://github.com/leaferjs/ai-docs

Last synced: 3 days ago
JSON representation

Leafer AI: Designed for training AI to learn LeaferJS.

• Host: GitHub
• URL: https://github.com/leaferjs/ai-docs
• Owner: leaferjs
• License: mit
• Created: 2025-02-13T02:23:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2026-06-11T01:02:21.000Z (3 days ago)
• Last Synced: 2026-06-11T02:22:12.610Z (3 days ago)
• Language: TypeScript
• Homepage: https://www.leaferjs.com
• Size: 15.2 MB
• Stars: 12
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README-EN.md
  • License: LICENSE

Awesome Lists containing this project

README

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




# Leafer AI

This repository provides usage examples and documentation of LeaferJS for AI systems, making it easier to generate and understand code.

It includes examples, tutorials, API references, plugin documentation, and source code.

## LeaferJS

Please note that LeaferJS can be abbreviated as **Leafer**.

Start by reading the [LeaferJS introduction](./introduction.md).

## Directory Structure

- **examples/**

  Standalone, runnable examples demonstrating various features of LeaferJS.

  This is the primary source for AI to learn usage patterns and best practices.

- **guide/**

  Quick start and step-by-step tutorials covering common use cases, including app creation, graphics, interaction, and animation.

- **reference/**

  API reference and detailed documentation.

- **plugin/**

  Documentation for LeaferJS plugins and extensions.

- **src/**

  Core TypeScript source code of LeaferJS, useful for understanding class structures and types.

- **update/**

  Changelog and version history (optional for AI to read).

## AI Usage Guidelines

When generating LeaferJS code:

1. Prioritize simple examples in `examples/`.

2. Refer to `guide/` and `reference/` for patterns and API usage.

## Run Code Online

- Online Playground: [https://www.leaferjs.com/playground/](https://www.leaferjs.com/playground/)

- Online Examples: [https://www.leaferjs.com/examples/](https://www.leaferjs.com/examples/)

## Example Prompt

```text

Prompt: Create a draggable rectangle using Leafer.

```

## Use Directly as Skills

Download and extract this repository locally, then rename it to `leafer-skills`.

You can place it directly into the `skills` directory of tools such as Claude, Codex, etc.