Update index.html

valgaze · Jun 23, 2023 · c28e46d · c28e46d
1 parent d8cd345
commit c28e46d
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/index.html b/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html><html lang="en"><head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Speedybot-mini Documentation</title> <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet"> <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:wght@400;500&display=swap" rel="stylesheet"> <style>*{box-sizing: border-box;}body{font-family: 'Roboto', sans-serif; line-height: 1.6; color: #333; max-width: 900px; margin: 0 auto; padding: 20px;}h1, h2, h3, h4, h5, h6{font-weight: 500; color: #444; margin-top: 20px;}h1{font-size: 2.5rem;}h2{font-size: 2rem; color: #555; margin-top: 40px;}h3{font-size: 1.75rem; color: #666; margin-top: 30px;}h4{font-size: 1.5rem;}h5{font-size: 1.25rem;}h6{font-size: 1rem;}p{font-size: 1rem; margin-top: 10px;}a{color: #3498db; text-decoration: none;}a:hover{color: #2980b9; text-decoration: underline;}code{font-family: 'Roboto Mono', monospace; background-color: #f7f7f7; padding: 2px 4px; border-radius: 3px;}pre{background-color: #f7f7f7; padding: 10px; border-radius: 5px; font-family: 'Roboto Mono', monospace;}hr{border: 0; border-top: 1px solid #eee; margin: 20px 0;}img{width: 100%; display: block; margin: 20px auto;}table{width: 100%; border-collapse: collapse; margin-top: 20px;}th, td{border: 1px solid #eee; padding: 10px; text-align: left;}th{background-color: #f7f7f7;}ul{padding-left: 20px;}</style></head><body> <h1>Speedybot-mini</h1> <img src="https://github.com/valgaze/speedybot-mini/raw/deploy/docs/assets/logo.png?raw=true" alt="Speedybot-mini Logo"> <p> <strong> <a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes">📚 API Docs</a> | <a href="#quickstarts">🚀 Quickstarts</a> </strong> | <a href="https://github.com/valgaze/speedybot-mini/discussions">💬 Get Help</a> </p><a href="https://github.com/valgaze/speedybot-gpt4">Looking for speedybot-gpt4? 🤖<b>Click here</b></a> <h2>Introduction</h2> <p> Speedybot-mini is powerful (but really easy to use!) conversation design tooling designed to help you create user-valuable bots as quickly as possible while providing a buttery-smooth developer experience. It allows you to focus on the essential aspects of your bot, such as content and powerful integrations, without getting bogged down in the details. </p><h2>Features</h2> <ul> <li>🌟 Zero External Dependencies 🌟</li><li>Adds support for <strong><a href="#chips">tappable suggestion "chips"</a></strong></li><li>Includes <strong><a href="#speedycard">SpeedyCard card builder</a></strong> (create rich <strong><a href="https://developer.webex.com/docs/api/guides/cards">Adaptive Cards</a></strong> without wrangling JSON)</li><li>Offers a variety of utilities for alerts, cards, files, and more</li><li>Locale & i18n support</li><li>Runs on virtually any infrastructure - servers, V8 isolates, containers, container-less, edge, etc</li></ul> <h2 id="quickstarts">Quickstarts</h2> <p>Get up and running quickly with Speedybot on various platforms:</p><ul> <li><strong><a href="https://codepen.io/valgaze/pen/MWVjEZV">speedybot garage 🔧🤖</a></strong>, manage webhooks/secrets/admin</li><li><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes">📚 API Docs</a></strong></li></ul> <h3>Supported Platforms</h3> <table> <thead> <tr> <th>Platform</th> <th>Needs server?</th> <th>Needs webhooks?</th> </tr></thead> <tbody> <tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/tree/deploy/examples/websockets">🔌 Deploy with websockets</a></strong></td><td>❌</td><td>❌</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook">💻 Deploy to Simple Express Server</a></strong></td><td>✅</td><td>✅</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/tree/deploy/examples/aws-lambda">λ Deploy to AWS Lamda</a></strong></td><td>❌</td><td>✅</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker">🔥 Deploy to Worker</a></strong></td><td>❌</td><td>✅</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno">🦖 Deploy to Deno</a></strong></td><td>❌</td><td>✅</td></tr></tbody> </table> <h2 id="syntax">Syntax</h2> <pre><code>npm install speedybot-mini</code></pre> <p><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/settings/config.ts">See starter bot</a></strong></p><h2 id="how-to-make-a-bot">How to make a bot</h2> <p>Speedybot is built with "handlers" that trigger based on specific conditions. Depending on your needs, you'll likely only need one or two handlers in your project. These days you're probably integrating with a NLU or LLM service, so you can pass through data that way</p><h3 id="keywords">Keywords</h3> <table> <thead> <tr> <th>Keyword</th> <th>Description</th> </tr></thead> <tbody> <tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#contains">.contains</a></strong></td><td>This will match if a trigger phrase is the 1st or only word in a message sent from a user.</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#fuzzy">.fuzzy</a></strong></td><td>This will match if a trigger phrase exists _anywhere_ inside a message sent from the user.</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#exact">.exact</a></strong></td><td>This will match if a trigger phrase is exactly (case-sensitive) a message sent from a user.</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#regex">.regex</a></strong></td><td>This will match if a message sent from a user passes the regex.</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#every">.every</a></strong></td><td>This will match on every message from a user.</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#nlu">.nlu</a></strong></td><td>This will match on every message from a user except if the trigger phrase is used by hard-coded handler, designed for use with natural language systems.</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#onSubmit">.onSubmit</a></strong></td><td>This will trigger when data is sent from an <a href="https://developer.webex.com/docs/api/guides/cards">Adaptive Card</a>.</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#onFile">.onFile</a></strong></td><td>This will trigger every time a file is sent to the agent and will provide file metadata.</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#onCamera">.onCamera</a></strong></td><td>This will trigger every time an image file is sent to the agent.</td></tr><tr> <td><strong><a href="https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#noMatch">.noMatch</a></strong></td><td>This will trigger if there are no registered handlers for the user's text.</td></tr></tbody> </table> <h2 id="speedycard">SpeedyCard</h2> <p>SpeedyCard is a simple and efficient way to create rich Adaptive Cards without having to deal with JSON. It's parly inspired by SwiftUI's "builder" pattern and offers a limited subset of AdaptiveCard features with a focus on user interaction and simplicity.</p><h2 id="chips">Chips</h2> <p>Chips are tappable suggestion buttons that you can include in your Adaptive Cards. They provide a more interactive user experience and can be easily integrated into your bot. Chips are managed statelessly by your Speedybot instance and require no coordination with the chat client.</p></body></html>
-const urlParams = new URLSearchParams(window.location.search);
+<script>const urlParams = new URLSearchParams(window.location.search);
 const garage = urlParams.get("garage") || urlParams.get("lab")
 const __LOCALE = urlParams.get("locale") || 'en'
 const gpt3 = urlParams.get('gpt3')
@@ -10,3 +10,4 @@
 if (gpt4 !== null) {
   window.location.replace('https://github.com/valgaze/speedybot-gpt4');
 }
+</script>