# README

[![Build Status](https://travis-ci.com/memspace/zefyr.svg?branch=master)](https://travis-ci.com/memspace/zefyr) [![codecov](https://codecov.io/gh/memspace/zefyr/branch/master/graph/badge.svg)](https://codecov.io/gh/memspace/zefyr)

*Soft and gentle rich text editing for Flutter applications.*

**You are viewing early dev preview version of this package which is no longer actively maintained. To follow latest updates see dev releases for `1.0.0-dev.x` versions. You can learn more about upcoming 1.0.0 release here:** [**https://github.com/memspace/zefyr/issues/409**](https://github.com/memspace/zefyr/issues/409)

For questions and general discussions check out our [Spectrum community](https://spectrum.chat/zefyr).

## Clean and modern look

Zefyr's rich text editor is built with simplicity and flexibility in mind. It provides clean interface for distraction-free editing. Think Medium.com-like experience.

![](https://github.com/memspace/zefyr/raw/master/assets/zefyr-1.png) ![](https://github.com/memspace/zefyr/raw/master/assets/zefyr-2.png)

## Markdown-inspired semantics

Ever needed to have a heading line inside of a quote block, like in this Markdown block:

> ### I'm a Markdown heading
>
> And I'm a regular paragraph

Zefyr can deliver exactly that:

![](https://github.com/memspace/zefyr/raw/master/assets/markdown-semantics.png)

## Ready for collaborative editing

Zefyr's document model uses data format compatible with [Operational Transformation](https://en.wikipedia.org/wiki/Operational_transformation) which makes it possible to use for collaborative editing use cases or whenever there is a need for conflict-free resolution of changes.

> Zefyr editor uses Quill.js **Delta** as underlying data format. Read more about Zefyr and Deltas in our [documentation](https://zefyr-editor.gitbook.io/docs/concepts/data-and-document). Make sure to checkout [official documentation](https://quilljs.com/docs/delta/) for Delta format as well.