# Lexxy

A modern rich text editor for Rails.

[Documentation](https://lexxy.dev/docs/) | <mark>[Try it out!](https://lexxy.dev/sandbox/)</mark>

## Features

- Built on top of [Lexical](https://lexical.dev), the powerful text editor framework from Meta.
- Good HTML semantics. Paragraphs are real `<p>` tags, as they should be.
- Markdown support: shortcuts, auto-formatting on paste.
- Real-time code syntax highlighting.
- Create links by pasting URLs on selected text.
- Configurable prompts. Support for mentions and other interactive prompts with multiple loading and filtering strategies.
- Preview attachments like PDFs and Videos in the editor.
- Works seamlessly with Action Text, generating the same canonical HTML format it expects for attachments.

![Lexxy editor screenshot](home/docs/images/home.screenshot.png)

## Contributing

- Bug reports and pull requests are welcome on [GitHub Issues](https://github.com/basecamp/lexxy/issues). Help is especially welcome with [those tagged as "Help Wanted"](https://github.com/basecamp/lexxy/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22).
- For questions and general Lexxy discussion, please use the [Discussions section](https://github.com/basecamp/lexxy/discussions)
- To build with a development version of Lexical, use `bin/link-to-local-lexical`.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

---

[![CI](https://github.com/basecamp/lexxy/actions/workflows/ci.yml/badge.svg)](https://github.com/basecamp/lexxy/actions/workflows/ci.yml)