feat: update blocky tree structures

vincentdchan · Nov 7, 2023 · f08bfd7 · f08bfd7 · vercel · Nov 7, 2023
1 parent 9cf144d
commit f08bfd7
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/packages/blocky-data/src/tree.ts b/packages/blocky-data/src/tree.ts
@@ -605,6 +605,21 @@ export interface DocumentInitProps {
   bodyChildren: DataBaseNode[];
 }
 
+/**
+ * The data model in Blocky Editor is represented as an XML Document:
+ * 
+ * <document>
+ *   <head>
+ *     <Title />
+ *   </head>
+ *   <body>
+ *     <Text />
+ *     <Text />
+ *     <Image src="" />
+ *     </Text>
+ *   </body>
+ * </document>
+ */
 export class BlockyDocument extends DataBaseElement {
   readonly title: BlockDataElement;
   readonly head: DataBaseElement;