readme.afdoc 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. {
  2. "document": {
  3. "type": "editor",
  4. "children": [
  5. { "type": "cover" },
  6. {
  7. "type": "text",
  8. "attributes": { "subtype": "heading", "heading": "h1" },
  9. "delta": [{ "insert": "Welcome to AppFlowy!" }]
  10. },
  11. {
  12. "type": "text",
  13. "attributes": { "subtype": "heading", "heading": "h2" },
  14. "delta": [{ "insert": "Here are the basics" }]
  15. },
  16. {
  17. "type": "text",
  18. "attributes": { "subtype": "checkbox", "checkbox": null },
  19. "delta": [{ "insert": "Click anywhere and just start typing." }]
  20. },
  21. {
  22. "type": "text",
  23. "attributes": { "subtype": "checkbox", "checkbox": false },
  24. "delta": [
  25. {
  26. "insert": "Highlight ",
  27. "attributes": { "backgroundColor": "0x4dffeb3b" }
  28. },
  29. { "insert": "any text, and use the editing menu to " },
  30. { "insert": "style", "attributes": { "italic": true } },
  31. { "insert": " " },
  32. { "insert": "your", "attributes": { "bold": true } },
  33. { "insert": " " },
  34. { "insert": "writing", "attributes": { "underline": true } },
  35. { "insert": " " },
  36. { "insert": "however", "attributes": { "code": true } },
  37. { "insert": " you " },
  38. { "insert": "like.", "attributes": { "strikethrough": true } }
  39. ]
  40. },
  41. {
  42. "type": "text",
  43. "attributes": { "subtype": "checkbox", "checkbox": null },
  44. "delta": [
  45. { "insert": "As soon as you type " },
  46. {
  47. "insert": "/",
  48. "attributes": { "code": true, "color": "0xff00b5ff" }
  49. },
  50. { "insert": " a menu will pop up. Select " },
  51. {
  52. "insert": "different types",
  53. "attributes": { "backgroundColor": "0x4d9c27b0" }
  54. },
  55. { "insert": " of content blocks you can add." }
  56. ]
  57. },
  58. {
  59. "type": "text",
  60. "attributes": { "subtype": "checkbox", "checkbox": null },
  61. "delta": [
  62. { "insert": "Type " },
  63. { "insert": "/", "attributes": { "code": true } },
  64. { "insert": " followed by " },
  65. { "insert": "/bullet", "attributes": { "code": true } },
  66. { "insert": " or " },
  67. { "insert": "/num", "attributes": { "code": true } },
  68. { "insert": " to create a list.", "attributes": { "code": false } }
  69. ]
  70. },
  71. {
  72. "type": "text",
  73. "attributes": { "subtype": "checkbox", "checkbox": true },
  74. "delta": [
  75. { "insert": "Click " },
  76. { "insert": "+ New Page ", "attributes": { "code": true } },
  77. {
  78. "insert": "button at the bottom of your sidebar to add a new page."
  79. }
  80. ]
  81. },
  82. {
  83. "type": "text",
  84. "attributes": { "subtype": "checkbox", "checkbox": null },
  85. "delta": [
  86. { "insert": "Click " },
  87. { "insert": "+", "attributes": { "code": true } },
  88. { "insert": " next to any page title in the sidebar to " },
  89. { "insert": "quickly", "attributes": { "color": "0xff8427e0" } },
  90. { "insert": " add a new subpage, " },
  91. { "insert": "Document", "attributes": { "code": true } },
  92. { "insert": ", ", "attributes": { "code": false } },
  93. { "insert": "Grid", "attributes": { "code": true } },
  94. { "insert": ", or ", "attributes": { "code": false } },
  95. { "insert": "Kanban Board", "attributes": { "code": true } },
  96. { "insert": ".", "attributes": { "code": false } }
  97. ]
  98. },
  99. { "type": "text", "delta": [] },
  100. { "type": "divider" },
  101. { "type": "text", "attributes": { "checkbox": null }, "delta": [] },
  102. {
  103. "type": "text",
  104. "attributes": {
  105. "subtype": "heading",
  106. "checkbox": null,
  107. "heading": "h2"
  108. },
  109. "delta": [{ "insert": "Keyboard shortcuts, markdown, and code block" }]
  110. },
  111. {
  112. "type": "text",
  113. "attributes": {
  114. "subtype": "number-list",
  115. "number": 1,
  116. "heading": null
  117. },
  118. "delta": [
  119. { "insert": "Keyboard shortcuts " },
  120. {
  121. "insert": "guide",
  122. "attributes": {
  123. "href": "https://appflowy.gitbook.io/docs/essential-documentation/shortcuts"
  124. }
  125. },
  126. { "retain": 1, "attributes": { "strikethrough": true } }
  127. ]
  128. },
  129. {
  130. "type": "text",
  131. "attributes": {
  132. "subtype": "number-list",
  133. "number": 2,
  134. "heading": null
  135. },
  136. "delta": [
  137. { "insert": "Markdown " },
  138. {
  139. "insert": "reference",
  140. "attributes": {
  141. "href": "https://appflowy.gitbook.io/docs/essential-documentation/markdown"
  142. }
  143. },
  144. { "retain": 1, "attributes": { "strikethrough": true } }
  145. ]
  146. },
  147. {
  148. "type": "text",
  149. "attributes": { "number": 3, "subtype": "number-list" },
  150. "delta": [
  151. { "insert": "Type " },
  152. { "insert": "/code", "attributes": { "code": true } },
  153. {
  154. "insert": " to insert a code block",
  155. "attributes": { "code": false }
  156. }
  157. ]
  158. },
  159. {
  160. "type": "text",
  161. "attributes": {
  162. "subtype": "code_block",
  163. "number": 3,
  164. "heading": null,
  165. "number-list": null,
  166. "theme": "vs",
  167. "language": "rust"
  168. },
  169. "delta": [
  170. {
  171. "insert": "// This is the main function.\nfn main() {\n // Print text to the console.\n println!(\"Hello World!\");\n}"
  172. },
  173. { "retain": 1, "attributes": { "strikethrough": true } }
  174. ]
  175. },
  176. { "type": "text", "attributes": { "checkbox": null }, "delta": [] },
  177. {
  178. "type": "text",
  179. "attributes": {
  180. "subtype": "heading",
  181. "checkbox": null,
  182. "heading": "h2"
  183. },
  184. "delta": [{ "insert": "Have a question❓" }]
  185. },
  186. {
  187. "type": "text",
  188. "attributes": { "subtype": "quote" },
  189. "delta": [
  190. { "insert": "Click " },
  191. { "insert": "?", "attributes": { "code": true } },
  192. { "insert": " at the bottom right for help and support." }
  193. ]
  194. },
  195. { "type": "text", "delta": [] },
  196. {
  197. "type": "callout",
  198. "children": [
  199. { "type": "text", "delta": [] },
  200. {
  201. "type": "text",
  202. "attributes": { "subtype": "heading", "heading": "h2" },
  203. "delta": [{ "insert": "Like AppFlowy? Follow us:" }]
  204. },
  205. {
  206. "type": "text",
  207. "attributes": { "subtype": "bulleted-list" },
  208. "delta": [
  209. {
  210. "insert": "GitHub",
  211. "attributes": {
  212. "href": "https://github.com/AppFlowy-IO/AppFlowy"
  213. }
  214. }
  215. ]
  216. },
  217. {
  218. "type": "text",
  219. "attributes": { "subtype": "bulleted-list" },
  220. "delta": [
  221. {
  222. "insert": "Twitter",
  223. "attributes": { "href": "https://twitter.com/appflowy" }
  224. },
  225. { "insert": ": @appflowy" }
  226. ]
  227. },
  228. {
  229. "type": "text",
  230. "attributes": { "subtype": "bulleted-list" },
  231. "delta": [
  232. {
  233. "insert": "Newsletter",
  234. "attributes": { "href": "https://blog-appflowy.ghost.io/" }
  235. }
  236. ]
  237. }
  238. ],
  239. "attributes": { "emoji": "😀" }
  240. },
  241. { "type": "text", "delta": [] },
  242. {
  243. "type": "text",
  244. "attributes": { "subtype": null, "heading": null },
  245. "delta": []
  246. },
  247. {
  248. "type": "text",
  249. "attributes": { "subtype": null, "heading": null },
  250. "delta": []
  251. }
  252. ]
  253. }
  254. }