# Resortable Documentation

Documentation index for [Resortable](../README.md) — a modern TypeScript rewrite of Sortable.js.

- **Hosted docs hub:** <https://jjeff.github.io/resortable/>
- **Back to the project:** [README](../README.md) · [GitHub repo](https://github.com/jjeff/resortable)

## Guides

| Guide                                                         | What's inside                                                 |
| ------------------------------------------------------------- | ------------------------------------------------------------- |
| [API Reference](https://jjeff.github.io/resortable/api/)      | TypeDoc — every exported class, interface, option, and type   |
| [Migration from Sortable v1](./migration-from-sortable-v1.md) | Option renames, plugin changes, and breaking-change delta     |
| [Plugin Development](./plugin-development.md)                 | Plugin lifecycle, hook reference, and authoring patterns      |
| [Accessibility](./accessibility.md)                           | Keyboard contract, ARIA attributes, and the WCAG 2.1 AA audit |

## Live demos

- [Examples](https://jjeff.github.io/resortable/demo/examples/) — nine standalone examples covering the v2 API surface
- [Showcase](https://jjeff.github.io/resortable/demo/) — polished demo page (Kanban, gallery, nested lists)
- [Playground](https://jjeff.github.io/resortable/demo/playground.html) — bare API harness for debugging and plugin
  testing

## Project docs

- [Architecture](../ARCHITECTURE.md) — internal modules, state, and event flow
- [Contributing](../CONTRIBUTING.md) — setup, conventions, and the PR checklist
- [Security](../SECURITY.md) — supported versions and vulnerability reporting
- [Changelog](../CHANGELOG.md) — release history (auto-generated by semantic-release)

> **Note:** the Markdown guides here render nicely on GitHub. The Migration and Plugin Development guides are not
> rebuilt into the static Pages site, so the hosted landing page links to these GitHub-rendered versions.