Browse Source

Another reorg using summary file

Anatoly Pulyaevskiy 5 years ago
parent
commit
6e7ecfd327
6 changed files with 22 additions and 20 deletions
  1. 0
    4
      .gitbook.yaml
  2. 7
    14
      README.md
  3. 13
    0
      SUMMARY.md
  4. 2
    2
      doc/concepts/attributes.md
  5. 0
    0
      doc/concepts/data-and-document.md
  6. 0
    0
      doc/quick-start.md

+ 0
- 4
.gitbook.yaml View File

@@ -1,4 +0,0 @@
1
-root: ./doc/
2
-
3
-structure:
4
-  readme: ./../README.md

+ 7
- 14
README.md View File

@@ -9,19 +9,12 @@ request or found a bug, please file it at the [issue tracker][].
9 9
 
10 10
 ### Documentation
11 11
 
12
-* [Quick Start][quick_start]
13
-* [Data Format and Document Model][data_and_document]
14
-* [Style attributes][attributes]
15
-* [Heuristic rules][heuristics]
16
-* [Images][images]
17
-* [FAQ][faq]
18
-
19
-[quick_start]: /doc/quick_start.md
20
-[data_and_document]: /doc/data_and_document.md
21
-[attributes]: /doc/attributes.md
22
-[heuristics]: /doc/heuristics.md
23
-[images]: /doc/images.md
24
-[faq]: /doc/faq.md
12
+* [Quick Start](doc/quick-start.md)
13
+* [Data Format and Document Model](doc/data-and-document.md)
14
+* [Style attributes](doc/attributes.md)
15
+* [Heuristic rules](doc/heuristics.md)
16
+* [Images](doc/images.md)
17
+* [FAQ](doc/faq.md)
25 18
 
26 19
 ## Clean and modern look
27 20
 
@@ -52,7 +45,7 @@ collaborative editing use cases or whenever there is a need for
52 45
 conflict-free resolution of changes.
53 46
 
54 47
 > Zefyr editor uses Quill.js **Delta** as underlying data format. Read
55
-> more about Zefyr and Deltas in our [documentation][data_and_document].
48
+> more about Zefyr and Deltas in our [documentation](doc/data-and-document.md).
56 49
 > Make sure to checkout [official documentation][delta] for Delta format
57 50
 > as well.
58 51
 

+ 13
- 0
SUMMARY.md View File

@@ -0,0 +1,13 @@
1
+# Summary
2
+
3
+## [About](README.md)
4
+
5
+## [Quick Start](doc/quick-start.md)
6
+
7
+## Concepts
8
+
9
+* [Data Format and Document Model](doc/data-and-document.md)
10
+* [Attributes](doc/attributes.md)
11
+* [Heuristic rules](doc/heuristics.md)
12
+
13
+## [FAQ](doc/faq.md)

+ 2
- 2
doc/concepts/attributes.md View File

@@ -1,7 +1,7 @@
1 1
 ## Style Attributes
2 2
 
3 3
 > If you haven't yet, read introduction to Zefyr document model called
4
-> Notus [here][data_and_document];
4
+> Notus [here](data-and-document.md);
5 5
 
6 6
 Style attributes in Notus documents are simple key-value pairs, where
7 7
 keys identify the attribute and value describes the style applied, for
@@ -116,4 +116,4 @@ a friendly user experience without this extra level in a document model.
116 116
 The `block` attribute in Notus documents is line-scoped. To change a
117 117
 group of lines from "bullet list" to "number list" we need to update
118 118
 block style on each of the lines individually. Zefyr editor abstracts
119
-away such details with help of [heuristic rules][heuristics].
119
+away such details with help of [heuristic rules](heuristics.md).

doc/concepts/data_and_document.md → doc/concepts/data-and-document.md View File


doc/quick_start.md → doc/quick-start.md View File