# @eaeao/summernote-react

> React + TypeScript port of the summernote WYSIWYG editor — the editor engine and React bindings in one package, with zero runtime dependencies and no jQuery.

## Overview
- [Overview](https://eaeao.github.io/summernote-react/docs/readme.md): Overview, install, quick start, and a feature summary.

## Tutorial
- [Getting started](https://eaeao.github.io/summernote-react/docs/getting-started.md): Install and build your first editor, step by step.

## How-to
- [Examples](https://eaeao.github.io/summernote-react/docs/examples.md): Copy-paste recipes: air mode, themes, i18n, image upload, custom toolbars, plugins.

## Reference
- [Component & state](https://eaeao.github.io/summernote-react/docs/reference-component.md): The <SummernoteEditor> props, the imperative ref handle, and EditorState.
- [Commands](https://eaeao.github.io/summernote-react/docs/reference-commands.md): The full command(name, ...args) catalog — the 50 built-in commands.
- [Options & toolbar](https://eaeao.github.io/summernote-react/docs/reference-options.md): Engine options, toolbar/popover item names, fonts, colors, keymap, themes, locales.
- [Headless & plugin API](https://eaeao.github.io/summernote-react/docs/reference-api.md): Headless useSummernote / createEditorCore and the definePlugin plugin API.

## Explanation
- [How it works](https://eaeao.github.io/summernote-react/docs/concepts.md): Architecture, the caret-safe controlled contract, and the security model.
- [Migrating from jQuery](https://eaeao.github.io/summernote-react/docs/migrating.md): Mapping the legacy jQuery summernote API to this React component.

## AI
- [Use with AI](https://eaeao.github.io/summernote-react/docs/use-with-ai.md): Use the library with AI coding tools: the shipped AGENTS.md / SKILL.md, Context7, agent rules, and llms.txt.

## Agent files
- [AGENTS.md](https://github.com/eaeao/summernote-react/blob/main/AGENTS.md): Dense, self-contained API reference shipped in the npm package.
- [SKILL.md](https://github.com/eaeao/summernote-react/blob/main/SKILL.md): Anthropic Agent Skill entry shipped in the npm package.
- [llms-full.txt](https://eaeao.github.io/summernote-react/llms-full.txt): The complete documentation concatenated into one file.