Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr Martian committed Jun 28, 2024
1 parent 85d556a commit 27c7c99
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,33 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>s2json-spec - v1.0.2</title><meta name="description" content="Documentation for s2json-spec"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">s2json-spec - v1.0.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>s2json-spec - v1.0.2</h2></div><div class="tsd-panel tsd-typography"><a id="md:s2json--------" class="tsd-anchor"></a><h1><a href="#md:s2json--------">s2json <a href="https://npmjs.org/package/s2json-spec"><img src="https://img.shields.io/npm/v/s2json-spec.svg?logo=npm&logoColor=white" alt="npm"></a> <a href="https://crates.io/crates/s2json"><img src="https://img.shields.io/crates/v/s2json.svg?logo=rust&logoColor=white" alt="crate"></a> <a href="https://www.npmjs.com/package/s2json-spec"><img src="https://img.shields.io/npm/dm/s2json-spec.svg" alt="downloads"></a> <a href="https://bundlejs.com/?q=s2json-spec"><img src="https://img.shields.io/bundlejs/size/s2json-spec?exports=VectorTile" alt="bundle"></a> <a href="https://open-s2.github.io/s2json/"><img src="https://img.shields.io/badge/docs-typescript-yellow.svg" alt="docs-ts"></a> <a href="https://docs.rs/s2json"><img src="https://img.shields.io/badge/docs-rust-yellow.svg" alt="docs-rust"></a> <img src="https://raw.githubusercontent.com/Open-S2/s2json/master/assets/doc-coverage.png" alt="doc-coverage"> <a href="https://discord.opens2.com"><img src="https://img.shields.io/discord/953563031701426206?logo=discord&logoColor=white" alt="Discord"></a></a></h1><a id="md:about" class="tsd-anchor"></a><h2><a href="#md:about">About</a></h2><p>S2JSON is a format for encoding a variety of geographic data structures that simplifies the GeoJSON spec and builds ontop of it to include S2 Geometry.</p>
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>s2json-spec - v1.0.2</title><meta name="description" content="Documentation for s2json-spec"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">s2json-spec - v1.0.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>s2json-spec - v1.0.2</h2></div><div class="tsd-panel tsd-typography"><h1 style="text-align: center;">
<div align="center">s2json</div>
</h1>

<p align="center">
<a href="https://npmjs.org/package/s2json-spec">
<img src="https://img.shields.io/npm/v/s2json-spec.svg?logo=npm&logoColor=white" alt="npm">
</a>
<a href="https://crates.io/crates/s2json">
<img src="https://img.shields.io/crates/v/s2json.svg?logo=rust&logoColor=white" alt="crate">
</a>
<a href="https://www.npmjs.com/package/s2json-spec">
<img src="https://img.shields.io/npm/dm/s2json-spec.svg" alt="downloads">
</a>
<a href="https://bundlejs.com/?q=s2json-spec&treeshake=%5B%7B+VectorTile+%7D%5D">
<img src="https://img.shields.io/bundlejs/size/s2json-spec?exports=VectorTile" alt="bundle">
</a>
<a href="https://open-s2.github.io/s2json/">
<img src="https://img.shields.io/badge/docs-typescript-yellow.svg" alt="docs-ts">
</a>
<a href="https://docs.rs/s2json">
<img src="https://img.shields.io/badge/docs-rust-yellow.svg" alt="docs-rust">
</a>
<img src="https://raw.githubusercontent.com/Open-S2/s2json/master/assets/doc-coverage.svg" alt="doc-coverage">
<a href="https://discord.opens2.com">
<img src="https://img.shields.io/discord/953563031701426206?logo=discord&logoColor=white" alt="Discord">
</a>
</p>

<a id="md:about" class="tsd-anchor"></a><h2><a href="#md:about">About</a></h2><p>S2JSON is a format for encoding a variety of geographic data structures that simplifies the GeoJSON spec and builds ontop of it to include S2 Geometry.</p>
<p>Notable features of S2JSON are:</p>
<ul>
<li>Properties data is clearly defined on how it can be shaped.</li>
Expand All @@ -14,6 +43,7 @@
<a id="md:read-the-spec" class="tsd-anchor"></a><h2><a href="#md:read-the-spec">Read The Spec</a></h2><p><a href="/s2json-spec/1.0.0/README.md">s2json-spec</a></p>
<a id="md:install" class="tsd-anchor"></a><h2><a href="#md:install">Install</a></h2><pre><code class="language-bash"><span class="hl-0"># bun</span><br/><span class="hl-5">bun</span><span class="hl-1"> </span><span class="hl-3">add</span><span class="hl-1"> </span><span class="hl-6">-D</span><span class="hl-1"> </span><span class="hl-3">s2json-spec</span><br/><span class="hl-0"># pnpm</span><br/><span class="hl-5">pnpm</span><span class="hl-1"> </span><span class="hl-3">add</span><span class="hl-1"> </span><span class="hl-6">-D</span><span class="hl-1"> </span><span class="hl-3">s2json-spec</span><br/><span class="hl-0"># yarn</span><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-3">add</span><span class="hl-1"> </span><span class="hl-6">-D</span><span class="hl-1"> </span><span class="hl-3">s2json-spec</span><br/><span class="hl-0"># npm</span><br/><span class="hl-5">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-6">-D</span><span class="hl-1"> </span><span class="hl-3">s2json-spec</span><br/><br/><span class="hl-0"># cargo</span><br/><span class="hl-5">cargo</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">s2json</span><span class="hl-1"> </span><span class="hl-6">--dev</span>
</code><button>Copy</button></pre>
<p>grammars/highlighting for VSCode are <a href="https://marketplace.visualstudio.com/items?itemName=OpenS2.s2json-spec">available for install</a>.</p>
<hr>
<a id="md:development" class="tsd-anchor"></a><h2><a href="#md:development">Development</a></h2><a id="md:requirements" class="tsd-anchor"></a><h3><a href="#md:requirements">Requirements</a></h3><p>You need the tool <code>tarpaulin</code> to generate the coverage report. Install it using the following command:</p>
<pre><code class="language-bash"><span class="hl-5">cargo</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">cargo-tarpaulin</span>
Expand All @@ -32,4 +62,4 @@
<a id="md:generating-coverage-report" class="tsd-anchor"></a><h3><a href="#md:generating-coverage-report">Generating Coverage Report</a></h3><p>To generate the coverage report, use the following command:</p>
<pre><code class="language-bash"><span class="hl-5">cargo</span><span class="hl-1"> </span><span class="hl-3">tarpaulin</span><br/><span class="hl-0"># bacon</span><br/><span class="hl-5">bacon</span><span class="hl-1"> </span><span class="hl-3">coverage</span><span class="hl-1"> </span><span class="hl-0"># or type `l` inside the tool</span>
</code><button>Copy</button></pre>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:s2json--------"><span>s2json </span></a><ul><li><a href="#md:about"><span>About</span></a></li><li><a href="#md:read-the-spec"><span>Read <wbr/>The <wbr/>Spec</span></a></li><li><a href="#md:install"><span>Install</span></a></li><li><a href="#md:development"><span>Development</span></a></li><li><ul><li><a href="#md:requirements"><span>Requirements</span></a></li><li><a href="#md:validated-your-data"><span>Validated <wbr/>Your <wbr/>Data</span></a></li><li><a href="#md:running-tests"><span>Running <wbr/>Tests</span></a></li><li><a href="#md:generating-coverage-report"><span>Generating <wbr/>Coverage <wbr/>Report</span></a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>s2json-spec - v1.0.2</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:about"><span>About</span></a><a href="#md:read-the-spec"><span>Read <wbr/>The <wbr/>Spec</span></a><a href="#md:install"><span>Install</span></a><a href="#md:development"><span>Development</span></a><ul><li><a href="#md:requirements"><span>Requirements</span></a></li><li><a href="#md:validated-your-data"><span>Validated <wbr/>Your <wbr/>Data</span></a></li><li><a href="#md:running-tests"><span>Running <wbr/>Tests</span></a></li><li><a href="#md:generating-coverage-report"><span>Generating <wbr/>Coverage <wbr/>Report</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>s2json-spec - v1.0.2</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>

0 comments on commit 27c7c99

Please sign in to comment.