hope this pushes demo to github pages

syonfox · Jan 8, 2023 · f324c53 · f324c53
1 parent fcbef4f
commit f324c53
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,8 @@ npm install @syonfox/gpt-3-encoder
 
 [![JSDocs](https://img.shields.io/badge/JS%20Docs-Read%20them%20maybe-brightgreen)](https://syonfox.github.io/GPT-3-Encoder/)
 
+Also check out the browser demo [browser demo](https://syonfox.github.io/GPT-3-Encoder/browser.html)
+
 ![GitHub last commit](https://img.shields.io/github/last-commit/syonfox/GPT-3-Encoder)
 
 

diff --git a/docs/Encoder.js.html b/docs/Encoder.js.html
@@ -370,7 +370,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Sat Jan 07 2023 22:41:18 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Sat Jan 07 2023 23:11:38 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/global.html b/docs/global.html
@@ -1070,7 +1070,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Sat Jan 07 2023 22:41:18 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Sat Jan 07 2023 23:11:38 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -173,7 +173,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Sat Jan 07 2023 22:41:18 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Sat Jan 07 2023 23:11:38 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/example/browser.html b/example/browser.html
@@ -5,6 +5,15 @@
   </head>
   <body>
     <h1>gpt-3-encoder Demo</h1>
+    <p>To install with npm:</p>
+    <pre class="prettyprint source"><code><span class="pln">npm install </span><span class="lit">@syonfox</span><span class="pun">/</span><span class="pln">gpt</span><span class="pun">-</span><span class="lit">3</span><span class="pun">-</span><span class="pln">encoder</span></code></pre>
+    <h2>Usage</h2>
+    <a href="https://www.npmjs.com/package/@syonfox/gpt-3-encoder">
+      <img src="https://img.shields.io/npm/v/@syonfox/gpt-3-encoder.svg" alt="npm version">
+    </a>
+    <p><a href="https://syonfox.github.io/GPT-3-Encoder/"><img src="https://img.shields.io/badge/JS%20Docs-Read%20them%20maybe-brightgreen" alt="JSDocs"></a></p>
+    <p><img src="https://img.shields.io/github/last-commit/syonfox/GPT-3-Encoder" alt="GitHub last commit"></p>
+    <p>Compatible with Node &gt;= 12</p>
     <p>Enter some text in the text field below to see how it is encoded and decoded by the gpt-3-encoder library:</p>
     <textarea id="input"></textarea>
     <button id="encode-button">Encode</button>

diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
     "example/*"
   ],
   "scripts": {
-    "docs": "jsdoc Encoder.js -r README.md -d docs",
+    "docs": "jsdoc Encoder.js -r README.md -d docs && cp example/browser.html docs",
     "dev": "webpack-dev-server",
     "build_bpe_ranks": "node build_bpe_ranks.js",
     "build": "browserify index.js -s gpt3encoder -o browser.js",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,6 +24,8 @@ npm install @syonfox/gpt-3-encoder

		[![JSDocs](https://img.shields.io/badge/JS%20Docs-Read%20them%20maybe-brightgreen)](https://syonfox.github.io/GPT-3-Encoder/)

		Also check out the browser demo [browser demo](https://syonfox.github.io/GPT-3-Encoder/browser.html)

		![GitHub last commit](https://img.shields.io/github/last-commit/syonfox/GPT-3-Encoder)


Expand Down