|
@@ -1,59 +1,6 @@
|
1
|
|
-# Zefyr [![Build Status](https://travis-ci.org/memspace/zefyr.svg?branch=master)](https://travis-ci.org/memspace/zefyr)
|
|
1
|
+# Zefyr
|
2
|
2
|
|
3
|
|
-*Soft and gentle rich text editing for Flutter applications.*
|
|
3
|
+This package provides a rich text editor for Flutter applications.
|
4
|
4
|
|
5
|
|
-Zefyr is currently in **early preview**. If you have a feature
|
6
|
|
-request or found a bug, please file it at the [issue tracker][].
|
|
5
|
+> For documentation see https://github.com/memspace/zefyr.
|
7
|
6
|
|
8
|
|
-[issue tracker]: https://github.com/memspace/zefyr/issues
|
9
|
|
-
|
10
|
|
-### Documentation
|
11
|
|
-
|
12
|
|
-* [Quick Start][quick_start]
|
13
|
|
-* [Data Format and Document Model][data_and_document]
|
14
|
|
-* [Style attributes][attributes]
|
15
|
|
-* [Heuristic rules][heuristics]
|
16
|
|
-* [FAQ][faq]
|
17
|
|
-
|
18
|
|
-[quick_start]: /doc/quick_start.md
|
19
|
|
-[data_and_document]: /doc/data_and_document.md
|
20
|
|
-[attributes]: /doc/attributes.md
|
21
|
|
-[heuristics]: /doc/heuristics.md
|
22
|
|
-[faq]: /doc/faq.md
|
23
|
|
-
|
24
|
|
-## Clean and modern look
|
25
|
|
-
|
26
|
|
-Zefyr's rich text editor is built with simplicity and flexibility in
|
27
|
|
-mind. It provides clean interface for distraction-free editing. Think
|
28
|
|
-Medium.com-like experience.
|
29
|
|
-
|
30
|
|
-[screenshot]
|
31
|
|
-
|
32
|
|
-## Markdown-style semantics
|
33
|
|
-
|
34
|
|
-Ever needed to have a heading line inside of a quote block, like in
|
35
|
|
-this Markdown block:
|
36
|
|
-
|
37
|
|
-> ### I'm a Markdown heading
|
38
|
|
-> And I'm a regular paragraph
|
39
|
|
-
|
40
|
|
-Zefyr can deliver exactly that:
|
41
|
|
-
|
42
|
|
-[screenshot]
|
43
|
|
-
|
44
|
|
-> Nested blocks support (e.g. lists inside quote blocks) is planned.
|
45
|
|
-
|
46
|
|
-## Collaborative editing built-in
|
47
|
|
-
|
48
|
|
-Zefyr's document model uses data format compatible with
|
49
|
|
-[Operational Transformation][ot] which makes it possible to use for
|
50
|
|
-collaborative editing use cases. Or whenever there is a need for
|
51
|
|
-conflict-free resolution of changes.
|
52
|
|
-
|
53
|
|
-> Zefyr editor uses Quill.js **Delta** as underlying data format. Read
|
54
|
|
-> more about Zefyr and Deltas in our [documentation][data_and_document].
|
55
|
|
-> Make sure to checkout [official documentation][delta] for Delta format
|
56
|
|
-> as well.
|
57
|
|
-
|
58
|
|
-[delta]: https://quilljs.com/docs/delta/
|
59
|
|
-[ot]: https://en.wikipedia.org/wiki/Operational_transformation
|