chore: update docs

JamesLMilner · Apr 7, 2023 · 75c0848 · 75c0848
1 parent 1662960
commit 75c0848
Show file tree

Hide file tree

Showing 19 changed files with 727 additions and 651 deletions.
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/TerraDraw.html b/docs/classes/TerraDraw.html
diff --git a/docs/classes/TerraDrawCircleMode.html b/docs/classes/TerraDrawCircleMode.html
diff --git a/docs/classes/TerraDrawFreehandMode.html b/docs/classes/TerraDrawFreehandMode.html
diff --git a/docs/classes/TerraDrawGoogleMapsAdapter.html b/docs/classes/TerraDrawGoogleMapsAdapter.html
diff --git a/docs/classes/TerraDrawGreatCircleMode.html b/docs/classes/TerraDrawGreatCircleMode.html
diff --git a/docs/classes/TerraDrawLeafletAdapter.html b/docs/classes/TerraDrawLeafletAdapter.html
diff --git a/docs/classes/TerraDrawLineStringMode.html b/docs/classes/TerraDrawLineStringMode.html
diff --git a/docs/classes/TerraDrawMapLibreGLAdapter.html b/docs/classes/TerraDrawMapLibreGLAdapter.html
diff --git a/docs/classes/TerraDrawMapboxGLAdapter.html b/docs/classes/TerraDrawMapboxGLAdapter.html
diff --git a/docs/classes/TerraDrawOpenLayersAdapter.html b/docs/classes/TerraDrawOpenLayersAdapter.html
diff --git a/docs/classes/TerraDrawPointMode.html b/docs/classes/TerraDrawPointMode.html
diff --git a/docs/classes/TerraDrawPolygonMode.html b/docs/classes/TerraDrawPolygonMode.html
diff --git a/docs/classes/TerraDrawRectangleMode.html b/docs/classes/TerraDrawRectangleMode.html
diff --git a/docs/classes/TerraDrawRenderMode.html b/docs/classes/TerraDrawRenderMode.html
diff --git a/docs/classes/TerraDrawSelectMode.html b/docs/classes/TerraDrawSelectMode.html
diff --git a/docs/index.html b/docs/index.html
@@ -18,6 +18,7 @@ <h2>terra-draw</h2></div>
 <a href="https://badge.fury.io/js/terra-draw"><img src="https://badge.fury.io/js/terra-draw.svg" alt="npm version"></a></p>
 <p>Frictionless map drawing across mapping libraries.</p>
 <p>Terra Draw centralises map drawing logic and provides a host of out the box drawing modes that work across different JavaScript mapping libraries. It also also you bring your own modes!</p>
+<p><img src="./readme.gif" alt="An example of drawing geodesic lines using Terra Draw with Leaflet"></p>
 
 <a href="#library-support" id="library-support" style="color: inherit; text-decoration: none;">
   <h3>Library Support</h3>
@@ -93,7 +94,8 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
 <li class="tsd-kind-class"><a href="classes/TerraDrawPolygonMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Terra<wbr/>Draw<wbr/>Polygon<wbr/>Mode</a></li>
 <li class="tsd-kind-class"><a href="classes/TerraDrawRectangleMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Terra<wbr/>Draw<wbr/>Rectangle<wbr/>Mode</a></li>
 <li class="tsd-kind-class"><a href="classes/TerraDrawRenderMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Terra<wbr/>Draw<wbr/>Render<wbr/>Mode</a></li>
-<li class="tsd-kind-class"><a href="classes/TerraDrawSelectMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Terra<wbr/>Draw<wbr/>Select<wbr/>Mode</a></li></ul></nav></div></div>
+<li class="tsd-kind-class"><a href="classes/TerraDrawSelectMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Terra<wbr/>Draw<wbr/>Select<wbr/>Mode</a></li>
+<li class="tsd-kind-variable"><a href="variables/TerraDrawExtend.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>Terra<wbr/>Draw<wbr/>Extend</a></li></ul></nav></div></div>
 <div class="container tsd-generator">
 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
 <div class="overlay"></div><script src="assets/main.js"></script></body></html>
diff --git a/docs/modules.html b/docs/modules.html
@@ -32,6 +32,10 @@ <h3 class="tsd-index-heading">Classes</h3>
 <a href="classes/TerraDrawRectangleMode.html" class="tsd-index-link tsd-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Terra<wbr/>Draw<wbr/>Rectangle<wbr/>Mode</span></a>
 <a href="classes/TerraDrawRenderMode.html" class="tsd-index-link tsd-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Terra<wbr/>Draw<wbr/>Render<wbr/>Mode</span></a>
 <a href="classes/TerraDrawSelectMode.html" class="tsd-index-link tsd-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Terra<wbr/>Draw<wbr/>Select<wbr/>Mode</span></a>
+</div></section>
+<section class="tsd-index-section">
+<h3 class="tsd-index-heading">Variables</h3>
+<div class="tsd-index-list"><a href="variables/TerraDrawExtend.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg><span>Terra<wbr/>Draw<wbr/>Extend</span></a>
 </div></section></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
@@ -70,7 +74,8 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
 <li class="tsd-kind-class"><a href="classes/TerraDrawPolygonMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Terra<wbr/>Draw<wbr/>Polygon<wbr/>Mode</a></li>
 <li class="tsd-kind-class"><a href="classes/TerraDrawRectangleMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Terra<wbr/>Draw<wbr/>Rectangle<wbr/>Mode</a></li>
 <li class="tsd-kind-class"><a href="classes/TerraDrawRenderMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Terra<wbr/>Draw<wbr/>Render<wbr/>Mode</a></li>
-<li class="tsd-kind-class"><a href="classes/TerraDrawSelectMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Terra<wbr/>Draw<wbr/>Select<wbr/>Mode</a></li></ul></nav></div></div>
+<li class="tsd-kind-class"><a href="classes/TerraDrawSelectMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Terra<wbr/>Draw<wbr/>Select<wbr/>Mode</a></li>
+<li class="tsd-kind-variable"><a href="variables/TerraDrawExtend.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Terra<wbr/>Draw<wbr/>Extend</a></li></ul></nav></div></div>
 <div class="container tsd-generator">
 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
 <div class="overlay"></div><script src="assets/main.js"></script></body></html>