started work on commands docs

2025-06-16 07:16:39 +00:00 · 2021-07-05 12:19:34 -07:00 · 2021-07-05 12:19:34 -07:00 · 37a28cc84a
commit 37a28cc84a
parent 153bfb8d0b
8 changed files with 265 additions and 51 deletions
--- a/docs/commands.md
+++ b/docs/commands.md
@ -0,0 +1,200 @@
+- stock :bank:
+- cryptocurrency :material-currency-btc:
+- otc :dollar:
+- bot :robot:
+
+# /donate :robot:
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /donate
+        </div>
+        <div class="message from">
+            The current stock price of Tesla Inc is $664.315, the stock is
+            currently down -0.99%
+        </div>
+    </div>
+</div>
+
+# /status :robot:
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /status
+        </div>
+        <div class="message from">
+Bot Status:
+        It took 0.783369 seconds for the bot to get your message.
+
+        Stock Market Data:
+        IEX Cloud is currently not reporting any issues with its API.
+
+        Cryptocurrency Data:
+        CoinGecko API responded that it was OK in 0.160962 Seconds.
+        </div>
+    </div>
+
+</div>
+
+# /dividend :bank:
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /dividend $psec
+        </div>
+        <div class="message from">
+The next dividend for $PSEC: Prospect Capital Corp is on Thursday, August 4 which is in 44 days. The dividend is for $0.06 per share.
+
+The dividend was declared on Monday, May 1 and the ex-dividend date is Tuesday, July 2
+
+        </div>
+    </div>
+
+</div>
+
+# /intra :bank: :material-currency-btc:
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /intra
+        </div>
+        <div class="message from">
+            The current stock price of Tesla Inc is $664.315, the stock is
+            currently down -0.99%
+        </div>
+    </div>
+</div>
+
+# /chart :bank: :material-currency-btc:
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /chart
+        </div>
+        <div class="message from">
+            The current stock price of Tesla Inc is $664.315, the stock is
+            currently down -0.99%
+        </div>
+    </div>
+</div>
+
+# /news :bank:
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /news
+        </div>
+        <pre class="message from">
+News for TSLA:
+Top Tech News: Elon Musk admits self-driving is harder than he thought as Tesla owners troll him over missed deadlines
+Bitcoin Ethereum News: DOGE Price Analysis $0.231 | Cryptopolitan
+Tesla North: Bugatti to Merge with EV Hypercar Startup Rimac
+Tesla North: China-Made Tesla Model 3 Battery Drain Test After 14 Days of Sleep
+Tesmanian: Brandenburg Minister Supports Bureaucratic Reform & Hopes Tesla Giga Berlin Production Starts this Year
+        </pre>
+    </div>
+</div>
+
+# /info :bank: :material-currency-btc:
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /info $spce
+        </div>
+        <div class="message from">
+Virgin Galactic Holdings, Inc. is a vertically integrated aerospace and space travel company, pioneering human spaceflight for private individuals and researchers, as well as a manufacturer of advanced air and space vehicles. It is developing a spaceflight system designed to offer customers a unique and transformative experience.
+        </div>
+    </div>
+</div>
+
+# /stat
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /stat $$ada
+        </div>
+        <pre class="message from">
+Cardano Statistics:
+    Market Cap: $0.0
+    Market Cap Ranking: None
+    CoinGecko Scores:
+        Overall: 8.928
+        Development: 0.0
+        Community: 12.066
+        Public Interest: 0.285
+        </pre>
+    </div>
+</div>
+
+# /trending
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /trending
+        </div>
+        <div class="message from">
+Trending Stocks:
+```
+$SPCE: Virgin Galactic Holdings Inc - Class A, 0.04%
+$MRIN: Marin Software Inc, 0.35%
+$AMC: AMC Entertainment Holdings Inc - Class A, -0.04%
+$ITRM: Iterum Therapeutics Plc, -0.38%
+$AAPL: Apple Inc, 0.02%
+$WISH: ContextLogic Inc - Class A, -0.05%
+$AHT: Ashford Hospitality Trust Inc, -0.08%
+$AMD: Advanced Micro Devices Inc., 0.01%
+$CTXR: Citius Pharmaceuticals Inc, -0.17%
+$F: Ford Motor Co., 0.00%
+```
+
+Trending Crypto:
+
+```
+$$BOND: BarnBridge, -5.29%
+$$SHIB: Shiba Inu, -3.76%
+$$SNX: Synthetix Network Token, 21.45%
+$$COMP: Compound, 11.95%
+$$MATIC: Polygon, -4.11%
+$$AXS: Axie Infinity, -9.02%
+$$MLN: Enzyme, 32.85%
+```
+
+        </div>
+    </div>
+
+</div>
+
+# /help
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /help
+        </div>
+        <div class="message from">
+            The current stock price of Tesla Inc is $664.315, the stock is
+            currently down -0.99%
+        </div>
+    </div>
+</div>
+
+# Inline Features
+
+You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots
+full list of stock symbols and return the price of the ticker. Then once you select the ticker
+want the bot will send a message as you in that chat with the latest stock price.
+The bot also looks at every message in any chat it is in for stock symbols.Symbols start with a
+`$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.
+
+Market data is provided by [IEX Cloud](https://iexcloud.io)
+
+    If you believe the bot is not behaving properly run `/status`.
--- a/docs/contact.md
+++ b/docs/contact.md
--- a/docs/host.md
+++ b/docs/host.md
@ -0,0 +1 @@
+
--- a/docs/img/telegramBotTickerReply.png
+++ b/docs/img/telegramBotTickerReply.png
--- a/docs/index.md
+++ b/docs/index.md
@ -1,7 +1,5 @@
 # Simple Stock Bots

-<style>.bmc-button img{height: 34px !important;width: 35px !important;margin-bottom: 1px !important;box-shadow: none !important;border: none !important;vertical-align: middle !important;}.bmc-button{padding: 7px 15px 7px 10px !important;line-height: 35px !important;height:51px !important;text-decoration: none !important;display:inline-flex !important;color:#FFFFFF !important;background-color:#FF813F !important;border-radius: 5px !important;border: 1px solid transparent !important;padding: 7px 15px 7px 10px !important;font-size: 22px !important;letter-spacing: 0.6px !important;box-shadow: 0px 1px 2px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 1px 2px 2px rgba(190, 190, 190, 0.5) !important;margin: 0 auto !important;font-family:'Cookie', cursive !important;-webkit-box-sizing: border-box !important;box-sizing: border-box !important;}.bmc-button:hover, .bmc-button:active, .bmc-button:focus {-webkit-box-shadow: 0px 1px 2px 2px rgba(190, 190, 190, 0.5) !important;text-decoration: none !important;box-shadow: 0px 1px 2px 2px rgba(190, 190, 190, 0.5) !important;opacity: 0.85 !important;color:#FFFFFF !important;}</style><link href="https://fonts.googleapis.com/css?family=Cookie" rel="stylesheet"><a class="bmc-button" target="_blank" href="https://www.buymeacoffee.com/Anson"><img src="https://cdn.buymeacoffee.com/buttons/bmc-new-btn-logo.svg" alt="Buy me a beer"><span style="margin-left:5px;font-size:28px !important;">Buy me a beer</span></a>
-
 [![Platform](https://img.shields.io/badge/platform-Telegram-blue.svg)](https://t.me/SimpleStockBot)
 [![Platform](https://img.shields.io/badge/platform-Discord-blue.svg)](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=0&scope=bot)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://tldrlegal.com/license/mit-license#summary)
@ -19,29 +17,23 @@ The bots can either be added to a server or can be direct messaged for the exact
 - [Telegram](https://t.me/SimpleStockBot)
 - [Discord](https://discordapp.com/oauth2/authorize?client_id=532045200823025666&permissions=2048&scope=bot)

-Alternatively, this project is completely open source and instructions on how to run your own instance of the bot are provided on each of the bots pages. [Hosting](#source-code)
+Alternatively, this project is completely open source and instructions on how to run your own instance of the bot are provided on each of the bots pages. [Hosting](#host)

 ## Usage

 The bots are nearly identical between platforms, but sometimes a platform will have a feature that only it supports such as Telegrams inline messaging or Discords embeds.

-### Automatic
+- `/donate [amount in USD]` to donate. 🎗️
+- `/dividend $[symbol]` Dividend information for the symbol. 📅
+- `/intra $[symbol]` Plot of the stocks movement since the last market open. 📈
+- `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊
+- `/news $[symbol]` News about the symbol. 📰
+- `/info $[symbol]` General information about the symbol. ℹ️
+- `/stat $[symbol]` Key statistics about the symbol. 🔢
+- `/trending` Trending Stocks and Cryptos. 💬
+- `/help` Get some help using the bot. 🆘

-Anytime the Bot is in your chat it will search all chats for `$` followed by a ticker. For example `$tsla` will return the following message for Tesla Motors:
-
-```
-The current stock price of Tesla Inc. is $321.35, the stock is currently up 2.7%
-```
-
-This works no matter where the ticker is in the message and you can have as many tickers as you want in the same message. For example:
-
-```
-I wonder how $aapl, $nflx, and $sono are performing today.
-```
-
-Will return:
-
-![Conversation With Simple Telegram Bot](img\telegramBotTickerReply.png)
+Please see [Commands](#commands) for detailed usage.

 ### Universal Commands

--- a/docs/stylesheets/phone.css
+++ b/docs/stylesheets/phone.css
@ -0,0 +1,39 @@
+/* https://codepen.io/RG/pen/bdfDI */
+.phone {
+  background: none repeat scroll 0 0 #fff;
+  /*border-left: 1px solid #ccc;
+      border-right: 1px solid #ccc;*/
+  color: #ffffff;
+  font-family: sans-serif;
+  line-height: 20px;
+  width: 80%;
+  margin: 0 auto;
+  overflow-x: hidden;
+  position: relative;
+  border-radius: 10px;
+}
+.messages-wrapper {
+  position: relative;
+}
+.message {
+  margin: 10px;
+  padding: 15px 20px;
+  position: relative;
+  overflow-x: auto;
+}
+.message.to {
+  border-radius: 20px 0px 20px 20px;
+  background-color: #2095fe;
+  color: #fff;
+  margin-left: 20%;
+}
+.message.from {
+  border-radius: 20px 20px 20px 0px;
+  background-color: #e5e4e9;
+  color: #363636;
+  margin-right: 20%;
+}
+.message.to + .message.to,
+.message.from + .message.from {
+  margin-top: -7px;
+}
--- a/docs/telegram.md
+++ b/docs/telegram.md
@ -1,24 +0,0 @@
-Keep up with the latest news for the bot in itsTelegram Channel: [https://t.me/simplestockbotnews](https://t.me/simplestockbotnews)
-
-## Commands
-
- `/donate [amount in USD]` to donate. 🎗️
- `/dividend $[symbol]` will return dividend information for the symbol. 📅
- `/intra $[symbol]` Plot of the stocks movement since the last market open. 📈
- `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊
- `/news $[symbol]` News about the symbol. 📰
- `/info $[symbol]` General information about the symbol. ℹ️
- `/stat $[symbol]` Key statistics about the symbol. 🔢
- `/help` Get some help using the bot. 🆘
-
-## Inline Features
-
-You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots
-full list of stock symbols and return the price of the ticker. Then once you select the ticker
-want the bot will send a message as you in that chat with the latest stock price.
-The bot also looks at every message in any chat it is in for stock symbols.Symbols start with a
-`$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.
-
-Market data is provided by [IEX Cloud](https://iexcloud.io)
-
-    If you believe the bot is not behaving properly run `/status`.
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -1,20 +1,20 @@
-site_name: Simple Stock Bot
+site_name: Simple Stock Bot Docs
 site_url: https://docs.simplestockbot.com
 edit_uri: /simple-stock-bots/site/tree/master/docs
 nav:
  - Home: index.md
-  - Telegram Commands: telegram.md
+  - Commands: commands.md
+  - Hosting: host.md
  - Donate: donate.md
-  - Contact (Email): mailto:anson@ansonbiggs.com
+  - Contact: contact.md
  - LICENSE: LICENSE.md
-  
-theme: 
+
+theme:
  name: "material"
  features:
    - navigation.tabs
  icon:
-    logo:
-      material/robot-love
+    logo: material/robot-love
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
@ -31,12 +31,18 @@ repo_url: https://gitlab.com/simple-stock-bots
 repo_name: Simple Stock Bots
 site_description: Simple Discord and Telegram chat bots for Stock Market Data.
 site_author: Anson Biggs
-copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> <a href="https://iexcloud.io">All market data is provided by IEX Cloud</a> <script data-name="BMC-Widget" src="https://cdnjs.buymeacoffee.com/1.0.0/widget.prod.min.js" data-id="Anson" data-description="Support me on Buy me a coffee!" data-message="Thank you for using my bots!" data-color="#5F7FFF" data-position="right" data-x_margin="18" data-y_margin="18"></script>
+copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>  <a href="https://iexcloud.io">All market data is provided by IEX Cloud</a> <script data-name="BMC-Widget" src="https://cdnjs.buymeacoffee.com/1.0.0/widget.prod.min.js" data-id="Anson" data-description="Support me on Buy me a coffee!" data-message="Thank you for using my bots!" data-color="#5F7FFF" data-position="right" data-x_margin="18" data-y_margin="18"></script>
+
+extra_css:
+  - stylesheets/phone.css

 markdown_extensions:
  - admonition
  - toc:
      permalink: true
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg

 plugins:
  - search