docs(example): 📝 updated document build system

The Jsdoc-postman-theme module gives us the ability to generate JSDoc and key Typescript interfaces into HTML code. I'm going to try it out with Github Pages.
AndrewDongminYoo · Apr 7, 2023 · d685238 · d685238
1 parent 55a7070
commit d685238
Show file tree

Hide file tree

Showing 22 changed files with 6,704 additions and 40 deletions.
diff --git a/.jsdoc-config.json b/.jsdoc-config.json
@@ -0,0 +1,30 @@
+{
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc", "closure"]
+  },
+  "source": {
+    "include": ["lib"],
+    "exclude": ["lib/commonjs", "lib/typescript"],
+    "includePattern": ".+\\.(j|t)s(doc)?$",
+    "excludePattern": "(^|\\/|\\\\)_",
+    "type": "module"
+  },
+  "plugins": ["tsd-jsdoc/dist/plugin", "plugins/markdown"],
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": false,
+    "highlightTutorialCode": true
+  },
+  "opts": {
+    "template": "./node_modules/postman-jsdoc-theme",
+    "encoding": "utf8",
+    "destination": "./docs",
+    "recurse": true,
+    "readme": "README.md"
+  },
+  "markdown": {
+    "parser": "gfm",
+    "hardwrap": false
+  }
+}
diff --git a/docs/NativeStepCounter.js.html b/docs/NativeStepCounter.js.html
@@ -0,0 +1,79 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>NativeStepCounter.js - Postman Documentation</title>
+
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/ionicons.min.css" />
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
+  </head>
+  <body>
+    <input type="checkbox" id="nav-trigger" class="nav-trigger" />
+    <label for="nav-trigger" class="navicon-button x">
+      <div class="navicon"></div>
+    </label>
+
+    <label for="nav-trigger" class="overlay"></label>
+
+    <nav>
+      <h2><a href="index.html">Home</a></h2>
+      <h3>Classes</h3>
+      <ul>
+        <li><a href="UnavailabilityError.html">UnavailabilityError</a></li>
+      </ul>
+      <h3>Global</h3>
+      <ul>
+        <li><a href="global.html#isStepCountingSupported">isStepCountingSupported</a></li>
+        <li><a href="global.html#isTurboModuleEnabled">isTurboModuleEnabled</a></li>
+        <li><a href="global.html#parseStepData">parseStepData</a></li>
+        <li><a href="global.html#RNStepCounter">RNStepCounter</a></li>
+        <li><a href="global.html#startStepCounterUpdate">startStepCounterUpdate</a></li>
+        <li><a href="global.html#stopStepCounterUpdate">stopStepCounterUpdate</a></li>
+      </ul>
+    </nav>
+
+    <div id="main">
+      <h1 class="page-title">NativeStepCounter.js</h1>
+
+      <section>
+        <article>
+          <pre class="prettyprint source linenums"><code>import { TurboModuleRegistry } from 'react-native';
+
+/**
+ * `StepCountData` is an object with four properties: `distance`, `steps`, `startDate`, and `endDate`.
+ * @typedef StepCountData object - The Object that contains the step count data.
+ * @property {string} counterType - The type of counter used to count the steps.
+ * @property {number} steps - The number of steps taken during the time period.
+ * @property {number} startDate - The start date of the data.
+ * @property {number} endDate - The end date of the data.
+ * @property {number} distance - The distance in meters that the user has walked or run.
+ * @property {number|undefined} floorsAscended - number of floors ascended (iOS only)
+ * @property {number|undefined} floorsDescended - number of floors descended (iOS only)
+ */
+
+export const NAME = 'RNStepCounter';
+export const VERSION = '0.1.11';
+export const eventName = 'StepCounter.stepCounterUpdate';
+/* Getting enforcing the module from the registry. */
+export default TurboModuleRegistry.get('RNStepCounter');
+//# sourceMappingURL=NativeStepCounter.js.map</code></pre>
+        </article>
+      </section>
+    </div>
+
+    <br class="clear" />
+
+    <footer>Documentation generated at Fri Apr 07 2023 16:28:09 GMT+0900 (Korean Standard Time)</footer>
+
+    <script>
+      prettyPrint();
+    </script>
+    <script src="scripts/linenumber.js"></script>
+  </body>
+</html>
diff --git a/docs/UnavailabilityError.html b/docs/UnavailabilityError.html
@@ -0,0 +1,140 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>UnavailabilityError - Postman Documentation</title>
+
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/ionicons.min.css" />
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
+  </head>
+  <body>
+    <input type="checkbox" id="nav-trigger" class="nav-trigger" />
+    <label for="nav-trigger" class="navicon-button x">
+      <div class="navicon"></div>
+    </label>
+
+    <label for="nav-trigger" class="overlay"></label>
+
+    <nav>
+      <h2><a href="index.html">Home</a></h2>
+      <h3>Classes</h3>
+      <ul>
+        <li><a href="UnavailabilityError.html">UnavailabilityError</a></li>
+      </ul>
+      <h3>Global</h3>
+      <ul>
+        <li><a href="global.html#isStepCountingSupported">isStepCountingSupported</a></li>
+        <li><a href="global.html#isTurboModuleEnabled">isTurboModuleEnabled</a></li>
+        <li><a href="global.html#parseStepData">parseStepData</a></li>
+        <li><a href="global.html#RNStepCounter">RNStepCounter</a></li>
+        <li><a href="global.html#startStepCounterUpdate">startStepCounterUpdate</a></li>
+        <li><a href="global.html#stopStepCounterUpdate">stopStepCounterUpdate</a></li>
+      </ul>
+    </nav>
+
+    <div id="main">
+      <h1 class="page-title">UnavailabilityError</h1>
+
+      <section>
+        <header>
+          <h2>UnavailabilityError</h2>
+
+          <div class="class-description">
+            <p>If you're using a method or property that's not available on the current platform, throw this error.</p>
+          </div>
+        </header>
+
+        <article>
+          <div class="container-overview">
+            <h2>Constructor</h2>
+
+            <h4 class="name" id="UnavailabilityError">
+              <span class="type-signature"></span>new UnavailabilityError<span class="signature"
+                >(moduleName, propertyName)</span
+              ><span class="type-signature"> &rarr; {Error}</span>
+            </h4>
+
+            <h5>Parameters:</h5>
+
+            <table class="params">
+              <thead>
+                <tr>
+                  <th>Name</th>
+
+                  <th>Type</th>
+
+                  <th class="last">Description</th>
+                </tr>
+              </thead>
+
+              <tbody>
+                <tr>
+                  <td class="name"><code>moduleName</code></td>
+
+                  <td class="type">
+                    <span class="param-type">string</span>
+                  </td>
+
+                  <td class="description last"><p>The name of the module.</p></td>
+                </tr>
+
+                <tr>
+                  <td class="name"><code>propertyName</code></td>
+
+                  <td class="type">
+                    <span class="param-type">string</span>
+                  </td>
+
+                  <td class="description last"><p>The name of the property.</p></td>
+                </tr>
+              </tbody>
+            </table>
+
+            <dl class="details">
+              <dt class="tag-source">Source:</dt>
+              <dd class="tag-source">
+                <ul class="dummy">
+                  <li><a href="index.js.html">index.js</a>, <a href="index.js.html#line82">line 82</a></li>
+                </ul>
+              </dd>
+            </dl>
+
+            <h5>Returns:</h5>
+
+            <div class="param-desc">
+              <p>The error.</p>
+            </div>
+
+            <dl class="param-type">
+              <dt>Type</dt>
+              <dd>
+                <span class="param-type">Error</span>
+              </dd>
+            </dl>
+
+            <h5>Example</h5>
+
+            <pre class="prettyprint"><code>if (!RNStepCounter.startStepCounterUpdate) {
+    throw new UnavailabilityError(NativeModuleName, eventName);
+```</code></pre>
+          </div>
+        </article>
+      </section>
+    </div>
+
+    <br class="clear" />
+
+    <footer>Documentation generated at Fri Apr 07 2023 16:28:09 GMT+0900 (Korean Standard Time)</footer>
+
+    <script>
+      prettyPrint();
+    </script>
+    <script src="scripts/linenumber.js"></script>
+  </body>
+</html>
diff --git a/docs/fonts/Lato-Regular.ttf b/docs/fonts/Lato-Regular.ttf
diff --git a/docs/fonts/OFL.txt b/docs/fonts/OFL.txt
@@ -0,0 +1,92 @@
+Copyright (c) 2010-2014 by tyPoland Lukasz Dziedzic (team@latofonts.com) with Reserved Font Name "Lato"
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/docs/fonts/SourceCodePro-Regular.ttf b/docs/fonts/SourceCodePro-Regular.ttf