GitBook: [#12] Added new documentation content.

jasonplatts · gitbook-bot · commit 08124b7cfa26 · 2022-04-17T19:42:02.000Z
diff --git a/.gitbook/assets/file.drawing.svg b/.gitbook/assets/file.drawing.svg
@@ -0,0 +1,16 @@
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 547 97" width="1094" height="194">
+  <!-- svg-source:excalidraw -->
+  <!-- payload-type:application/vnd.excalidraw+json --><!-- payload-version:2 --><!-- payload-start -->eyJ2ZXJzaW9uIjoiMSIsImVuY29kaW5nIjoiYnN0cmluZyIsImNvbXByZXNzZWQiOnRydWUsImVuY29kZWQiOiJ4nN1YXXObOFx1MDAxNH3Pr/C4r3Eq9Fx1MDAwMShvSZxMPKnTbuw2m+70QVx1MDAwNdlmg4FFslx1MDAxZCeT/75cdTAwMDK7IDDGbj5cdTAwMWG3jCdB0pXu5eqce1x1MDAwNFx1MDAwZnuNRlPOI948bDT5ncN8z43ZrLmf9E95LLwwUEMwbYtwXHUwMDEyO6nlSMpIXHUwMDFjvn/Pouhg6MnvYXh74ITjxTTu8zFcdTAwMGakUIb/qHaj8ZD+1Vx1MDAxY8XckSxcdTAwMTj6PJ2QXHUwMDBl5b5cdTAwMTDE5d7LMEj92iY2TERcciMz8ERbuZPcVaNcdTAwMDPmXHUwMDBino8kXc3ZWFx1MDAwNlwiPDmeTGd80PoyuenR7lHudeD5fk/O/cVDMWc0ibWYhIzDW37tuXKkxo1SfzZPhCpp+aw4nFxmR1x1MDAwMVx1MDAxN6IwJ4yY48l50lx1MDAwN0DWu0jCYSPvuVMtgvJ2Mlx1MDAwM1x1MDAwM1LyfVx1MDAxMvphnPh+XHUwMDA30iv3/p05t0NcdTAwMTVC4GY2MmaBiFis9iS3m/14Kkizvlx1MDAxMfeGI6k6rXxcdTAwMDdcdTAwMDRPc2tgXHUwMDAyTZtinFsnXqKOm27zt3JuRiyOljloiqShRZhcdTAwMDR3WsaIjlx1MDAxM23/eq7bXHUwMDEz0y83fE7dy+vuXHUwMDE0ym7Hz9YqgIrFcThrZiOPy7s8tEnkslx1MDAwNVJcZpNcdTAwMDBcYpFJkGnb2bjvXHUwMDA1t2owmPh+2vW4X41eye9kXHUwMDE1cFxyXHKXZeBcdTAwMDJqXHUwMDEzm1x1MDAxYXRr4Fx1MDAxYYK0Zyy8cj633Vx1MDAwMb/7OD+R2N954Fx1MDAxMrNcYlxcVPb9csC10CpuIanALbKIXHS1QF5cZrdPQla+g2Ege959kkRcYlxuvWds7PnzwiakkFMhfYrDf1Xt1LMmuFo9WcWwXHUwMDBi5ke+N0xQ2fT5oFxiV+mpMp9ccstQe0ZHuWdqubjjluNccmNv6Fx1MDAwNczvl0KppUptocdcdTAwMDCt41x1MDAwYlx1MDAwNIRcdTAwMDCEiVb4Nlx1MDAxMebr4MO9OLNcIncgLltHl3/dnV10urtOXHUwMDE4XHUwMDBillxiXHUwMDAz8KtcdTAwMTFm20pvXHUwMDAzy8K2jX5xpVx1MDAxZkz6M1x1MDAwNqzp3/25ezpcdTAwMTLts9CPL6orfcqGvNDvVy9bWa43Oty47LN1qXbd+46A//ni6/z68/F930Sd824gd1Xv8Fq9g1x1MDAwMFx1MDAxMFxuIUbbXHUwMDBiXv3+7yp/NV1J+atx7MX5a1TwXHUwMDE3ojJ/KVX7nKjeXHUwMDFmIXinridVbir1zipYZ4LmqHB5XFyjeGPPdXVFKoreJiEp6+AywmfIIDLX0cggqlx1MDAxMiNcYsH2LzzGUct0javInrdM2u1/wOftm6tdp1x1MDAxMYV2kUZcdTAwMDC+tVxmYopcYsBcYr5cdTAwMDKNniZXfXF20Vx1MDAxMiwgbeNkQIadc9n5yP5IWaE1x0JKXHUwMDAxgMS0tuZDddp2nVx1MDAwZlxiXHUwMDE1+aDB8I1kxSA2wrZpmujlXHTxXHUwMDA2utJcdTAwMGWdybiQj1+gLFx1MDAxYmpzWVmyXHUwMDE4a2m04GuVrmigKfHIgurlSu3l9m9X9efdV6dcdTAwMTF4XHUwMDEyjXSwLj5HvN7pjFirLFx1MDAwMisksm2AiaF/KNqaRGksTyVcdTAwMTHGwKolkZAslsde4HrBUI3lXHUwMDEy8uNrbmeLz6kp7ZxJXHUwMDEyTlx1MDAwYlx1MDAxY1x1MDAwMNso/KhmNmRRslx1MDAxZsuOTLuaPHA3XHUwMDA3UX9A04JQMVx1MDAxMFxc+JkrMZgrMfhMyJNwPPakSuKn0Fx1MDAwYmRlso5cdTAwMTLejThb+VCinmHtWJQsVzxcdTAwMDTkd41cdTAwMWMwaSO7/7ZfaZ1DrmS+p///6bqB6PrzqFx1MDAwNZBpJVxuvHXhqD957GjhsEleKNLCgUHJ98tcdTAwMTVcdTAwMGWtXGJnhUN70kXhQCbGyKBWbvt71Y2foSwwsGFBXG4opsRWx3BcdTAwMTNrds8qXHUwMDFj9fpbjFx1MDAwMlpcdTAwMTayMbBVXGJcdTAwMTZCls61tUH8NpUjx1xccrWMdaVjb7lCk0VRTypwZMlV+PPc5akrj7M59fjseJVcdTAwMDDvXHUwMDA26ZVcdTAwMWNk0mwltOfJwzw87j3+XHUwMDBmO71cdTAwMTX8In0=<!-- payload-end -->
+  <defs>
+    <style>
+      @font-face {
+        font-family: "Virgil";
+        src: url("https://excalidraw.com/Virgil.woff2");
+      }
+      @font-face {
+        font-family: "Cascadia";
+        src: url("https://excalidraw.com/Cascadia.woff2");
+      }
+    </style>
+  </defs>
+  <rect x="0" y="0" width="547" height="97" fill="#ffffff"/><g stroke-linecap="round" transform="translate(10 13) rotate(0 64.5 37)"><path d="M1.51 -1.3 C39.57 -0.47, 75.06 0.39, 128.7 0.85 M0.4 -0.56 C26.95 0.92, 53.24 0.69, 128.52 0.27 M130.63 -1.36 C128.97 23.21, 128.12 44.3, 127.92 75.96 M129.11 -0.33 C129.89 25.73, 130.31 50.63, 128.54 73.03 M129.05 73.36 C95.9 74.75, 66.67 75.18, 0.5 72.84 M129.73 73.03 C100.56 73.61, 71.75 74.43, 0.68 73.93 M-1.77 74.26 C-1.57 54.21, 0.1 36.48, 1.02 0.02 M0.13 74.27 C-0.6 57.71, 0.23 42.37, -0.95 0.09" stroke="#000000" stroke-width="1" fill="none"/></g><g transform="translate(36 39) rotate(0 36.5 12.5)"><text x="0" y="18" font-family="Virgil, Segoe UI Emoji" font-size="20px" fill="#000000" text-anchor="start" style="white-space: pre;" direction="ltr">Project</text></g><g stroke-linecap="round" transform="translate(206 12) rotate(0 64.5 37)"><path d="M-1.67 -1.77 C37.99 -1.44, 74.97 0.23, 130.05 1.02 M-0.78 0.13 C39.07 -0.35, 76.83 0.47, 128.38 -0.95 M130.14 0.17 C127.98 22.32, 130.44 43.9, 129.31 74.92 M129.14 0.83 C128.41 23.82, 129.06 46.48, 129.36 74.24 M130.81 75.23 C79.28 72.73, 27.11 74.93, 0.2 73.32 M128.96 73.1 C99.76 73.99, 70.31 74.48, 0.85 73.44 M-0.99 72.96 C-2.26 57.94, 0.76 37.36, -1.41 -1.19 M-0.74 73.03 C-0.59 57.57, -0.12 40.51, 0.8 0.52" stroke="#000000" stroke-width="1" fill="none"/></g><g transform="translate(211 37) rotate(0 59.5 11.5)"><text x="59.5" y="17" font-family="Virgil, Segoe UI Emoji" font-size="20px" fill="#000000" text-anchor="middle" style="white-space: pre;" direction="ltr">Editor</text></g><g stroke-linecap="round" transform="translate(408 10) rotate(0 64.5 37)"><path d="M0.83 1.53 C50.91 1.55, 101.25 1.38, 128.13 0.09 M-0.22 0.43 C27.46 -0.6, 55.34 -0.75, 129.33 0.94 M130.78 0.54 C127.99 22.9, 130.03 45.55, 130.62 75.7 M128.8 0.8 C129.03 24.39, 128.68 49.76, 129.16 73.17 M127.45 75.49 C80.1 72.62, 35.49 73.97, 1.81 72.16 M128.83 74.95 C94.54 74.6, 58.97 75.6, 0.74 74.41 M0.81 72.62 C1.44 52.81, 0.82 28.93, 1.52 -0.93 M0.44 74.3 C-0.15 54.06, -0.66 34.61, 0.13 0.19" stroke="#000000" stroke-width="1" fill="none"/></g><g transform="translate(413 35) rotate(0 59.5 11.5)"><text x="59.5" y="17" font-family="Virgil, Segoe UI Emoji" font-size="20px" fill="#000000" text-anchor="middle" style="white-space: pre;" direction="ltr">Document</text></g><g stroke-linecap="round"><g transform="translate(143 47) rotate(0 28.5 0)"><path d="M0 0 C9.5 0, 47.5 0, 57 0 M0 0 C9.5 0, 47.5 0, 57 0" stroke="#000000" stroke-width="1" fill="none"/></g></g><g stroke-linecap="round"><g transform="translate(339 48) rotate(0 32.5 -0.5)"><path d="M0 0 C10.83 -0.17, 54.17 -0.83, 65 -1 M0 0 C10.83 -0.17, 54.17 -0.83, 65 -1" stroke="#000000" stroke-width="1" fill="none"/></g></g></svg>
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -13,10 +13,11 @@
 
 * [Building a Language Extension](guides/building-a-language-extension.md)
 * [Building a Treeview Extension](guides/building-a-treeview-extension.md)
+* [Creating a Custom UI](guides/creating-a-custom-ui.md)
 
 ## API Reference
 
-* [API Structure](api-reference/api-structure.md)
+* [API Object Model](api-reference/api-object-model.md)
 * [Editor](api-reference/editor.md)
 * [Completion Provider](api-reference/completion-provider.md)
 
diff --git a/api-reference/api-object-model.md b/api-reference/api-object-model.md
@@ -0,0 +1,7 @@
+---
+description: Understand how the CodeEdit extension API objects relate to one another.
+---
+
+# API Object Model
+
+<img src="../.gitbook/assets/file.drawing.svg" alt="CodeEdit Extension API Object Model" class="gitbook-drawing">
diff --git a/api-reference/api-structure.md b/api-reference/api-structure.md
diff --git a/guides/building-a-language-extension.md b/guides/building-a-language-extension.md
@@ -1,2 +1,6 @@
-# Page 1
+---
+description: Learn how to build a basic language extension.
+---
+
+# Building a Language Extension
 
diff --git a/guides/creating-a-custom-ui.md b/guides/creating-a-custom-ui.md
@@ -0,0 +1,2 @@
+# Creating a Custom UI
+
