Skip to content

Getting Started ​

SweetEditor is a Compose Multiplatform code editor library backed by a native C++17 core.

What You Get ​

  • Compose Multiplatform editor UI
  • Native editor kernel integration
  • Decoration, completion, and IME pipelines
  • Android, iOS, Desktop, JS, and Wasm targets

Repository Structure ​

  • editor-compose: Kotlin Multiplatform wrapper and Compose UI integration
  • editor-core: native editor kernel and C API
  • example: Compose demo application
  • platform-demo: platform-specific demo implementations

Start Exploring ​

  1. Read Installation
  2. Follow Quick Start
  3. Explore Usage
  4. Inspect the example module
  5. Open the 中文文档 if you prefer Chinese
  6. Review platform-implementation-standard

Core Library ​

The native editor core used by this project is based on:

Suggested Reading Path ​

SweetEditor documentation site powered by VitePress.