mirror of
https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot.git
synced 2025-06-16 15:06:53 +00:00
literally copy in the docs
This commit is contained in:
parent
ad4262777d
commit
676b702c71
1
docs/.gitignore
vendored
Normal file
1
docs/.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
.cache
|
||||||
11
docs/.gitlab-ci.yml
Normal file
11
docs/.gitlab-ci.yml
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
image: python:3.11
|
||||||
|
pages:
|
||||||
|
stage: deploy
|
||||||
|
script:
|
||||||
|
- pip install -r requirements.txt
|
||||||
|
- mkdocs build --site-dir public --verbose
|
||||||
|
artifacts:
|
||||||
|
paths:
|
||||||
|
- public
|
||||||
|
rules:
|
||||||
|
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
|
||||||
12
docs/.vscode/settings.json
vendored
Normal file
12
docs/.vscode/settings.json
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"yaml.schemas": {
|
||||||
|
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
|
||||||
|
},
|
||||||
|
"yaml.customTags": [
|
||||||
|
"!ENV scalar",
|
||||||
|
"!ENV sequence",
|
||||||
|
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
|
||||||
|
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
|
||||||
|
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
|
||||||
|
]
|
||||||
|
}
|
||||||
21
docs/LICENSE
Normal file
21
docs/LICENSE
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2019 Anson Biggs
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
30
docs/README.md
Normal file
30
docs/README.md
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
# Simple Stock Bots
|
||||||
|
[](https://t.me/SimpleStockBot)
|
||||||
|
[](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot)
|
||||||
|
[](https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
+ [About](#about)
|
||||||
|
+ [Getting Started](#getting_started)
|
||||||
|
+ [Usage](#usage)
|
||||||
|
+ [Contributing](../CONTRIBUTING.md)
|
||||||
|
|
||||||
|
## About <a name = "about"></a>
|
||||||
|
Simple Stock Bots is a family of messaging bots that aim to provide simple bots that provide information on the stock market. Currently there are only [Telegram](./telegram) and [Discord](./discord) Bots.
|
||||||
|
|
||||||
|
## Getting Started <a name = "getting_started"></a>
|
||||||
|
|
||||||
|
The simplest way to use these bots is to use the version that I host on Digital Ocean. You can find the links to access them below:
|
||||||
|
|
||||||
|
+ [Telegram](https://t.me/SimpleStockBot)
|
||||||
|
+ [Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&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.
|
||||||
|
|
||||||
|
## Source Code
|
||||||
|
|
||||||
|
The source code for the bots is completely open and hosted on Gitlab.
|
||||||
|
|
||||||
|
+ [Telegram](https://gitlab.com/simple-stock-bots/simple-telegram-bot)
|
||||||
|
+ [Discord](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)
|
||||||
23
docs/docs/LICENSE.md
Normal file
23
docs/docs/LICENSE.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
```
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2019 Anson Biggs
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
```
|
||||||
176
docs/docs/commands.md
Normal file
176
docs/docs/commands.md
Normal file
@ -0,0 +1,176 @@
|
|||||||
|
Symbols are used in headings to denote what platforms and symbol types a command supports.
|
||||||
|
|
||||||
|
- Telegram Only :fontawesome-brands-telegram-plane:
|
||||||
|
- Discord Only :fontawesome-brands-discord:
|
||||||
|
- Bot Commands :robot:
|
||||||
|
- Cryptocurrency Support :material-currency-btc:
|
||||||
|
- Stock Market Support :bank:
|
||||||
|
- OTC Support :dollar:
|
||||||
|
|
||||||
|
## Symbol Detection :material-currency-btc: :bank: :dollar:
|
||||||
|
|
||||||
|
The Simple Stock Bot looks at every message it can see and tries to detect stock and cryptocurrency symbols. Stock market tickers are denoted with a single `$` and cryptocurrency coins are denoted with a double `$$`. So getting the price of Tesla is as simple as `$tsla` and Bitcoin `$$btc`. These symbols can be in any part of a message and there can be multiple of them aswell.
|
||||||
|
|
||||||
|
<div class="phone">
|
||||||
|
<div class="messages-wrapper">
|
||||||
|
<div class="message to">
|
||||||
|
I wonder how $tsla is affecting the price of $$btc
|
||||||
|
</div>
|
||||||
|
<div class="message from">
|
||||||
|
The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68%
|
||||||
|
</div>
|
||||||
|
<div class="message from">
|
||||||
|
The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane:
|
||||||
|
|
||||||
|
The donate command is used to send money to the bot to help keep it free. The premium stock market data and server rentals add up so any amount helps. See the [Donate](donate.md) page for more information.
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
## `/intra [symbol]` :bank: :material-currency-btc:
|
||||||
|
|
||||||
|
This command makes a chart of a stocks movement since the last market open, or the last 24 hours for cryptocurrency.
|
||||||
|
|
||||||
|
<div class="phone">
|
||||||
|
<div class="messages-wrapper">
|
||||||
|
<div class="message to">
|
||||||
|
/intra $astr
|
||||||
|
</div>
|
||||||
|
<div class="message from">
|
||||||
|
<img src="/img/TgIntraChat.jpg" alt="Tesla Motors Chart" />
|
||||||
|
<p>Intraday chart for $ASTR from 06 Jul at 09:30 to 06 Jul at 15:59</p>
|
||||||
|
<p>The current stock price of Astra Space Inc - Class A is $12.47, the stock is currently down -19.39%</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## `/chart [symbol]` :bank: :material-currency-btc:
|
||||||
|
|
||||||
|
This command makes a chart of the last 1 month of trading data up until the day before. For example running it on May 5th creates a chart from April 5th to May 4th.
|
||||||
|
|
||||||
|
<div class="phone">
|
||||||
|
<div class="messages-wrapper">
|
||||||
|
<div class="message to">
|
||||||
|
/intra $astr
|
||||||
|
</div>
|
||||||
|
<div class="message from">
|
||||||
|
<img src="/img/TgChartChat.jpg" alt="Tesla Motors Chart" />
|
||||||
|
<p>1 Month chart for Ethereum from 07, Jun 2021 to 07, Jul 2021</p>
|
||||||
|
<p>The current price of Ethereum is $2,389.62, the coin is currently up 2.485% for today</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## `/trending`
|
||||||
|
|
||||||
|
Gets the latest trending stocks and their change in price
|
||||||
|
|
||||||
|
<div class="phone">
|
||||||
|
<div class="messages-wrapper">
|
||||||
|
<div class="message to">
|
||||||
|
/trending
|
||||||
|
</div>
|
||||||
|
<pre class="message from">
|
||||||
|
|
||||||
|
🦍Trending on the Stock Bot:
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
$GME: Gamestop Corporation - Class A, 5.06%
|
||||||
|
$MMAT: Meta Materials Inc, 4.77%
|
||||||
|
$$BTC: Bitcoin, -0.83%
|
||||||
|
$$ETH: Ethereum, 6.06%
|
||||||
|
$$DOGE: Binance-Peg Dogecoin, 0.14%
|
||||||
|
|
||||||
|
|
||||||
|
💵Trending Stocks:
|
||||||
|
━━━━━━━━━━━━━━━━
|
||||||
|
$BBIG: Vinco Ventures Inc, 15.44%
|
||||||
|
$GSAT: Globalstar Inc., -15.32%
|
||||||
|
$AMC: AMC Entertainment Holdings Inc - Class A, 8.77%
|
||||||
|
$ACIU: AC Immune SA, 16.31%
|
||||||
|
$PLTR: Palantir Technologies Inc - Class A, 2.25%
|
||||||
|
$AAPL: Apple Inc, -0.84%
|
||||||
|
$XELA: Exela Technologies Inc, 12.61%
|
||||||
|
$WFC: Wells Fargo & Co., -5.60%
|
||||||
|
$BAC: Bank Of America Corp., 0.22%
|
||||||
|
$AMD: Advanced Micro Devices Inc., -0.54%
|
||||||
|
|
||||||
|
|
||||||
|
🦎Trending Crypto:
|
||||||
|
━━━━━━━━━━━━━━━━
|
||||||
|
$$NFD: Feisty Doge NFT, -34.32%
|
||||||
|
$$SLP: Smooth Love Potion, -13.02%
|
||||||
|
$$PVU: Plant vs Undead Token, -1.27%
|
||||||
|
$$XED: Exeedme, 1.02%
|
||||||
|
$$SOL: Solana, -3.95%
|
||||||
|
$$BNB: Binance Coin, -0.25%
|
||||||
|
$$EWT: Energy Web Token, 17.72%
|
||||||
|
|
||||||
|
</pre>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## /help :robot:
|
||||||
|
|
||||||
|
Just a simple command to get help in app. Returns a more summarized version of this page.
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
## `/status` :robot:
|
||||||
|
|
||||||
|
This command is to get diagnostic information about the bot and the services it is dependant on in order to operate. Any issues should be reported to me. [Contact](contact.md)
|
||||||
|
|
||||||
|
<div class="phone">
|
||||||
|
<div class="messages-wrapper">
|
||||||
|
<div class="message to">
|
||||||
|
/status
|
||||||
|
</div>
|
||||||
|
<pre class="message from">
|
||||||
|
Bot Status:
|
||||||
|
It took 0.783369 seconds for the bot to get your message.
|
||||||
|
|
||||||
|
Stock Market Data:
|
||||||
|
marketdata.app is currently not reporting any issues with its API.
|
||||||
|
|
||||||
|
Cryptocurrency Data:
|
||||||
|
CoinGecko API responded that it was OK in 0.160962 Seconds.
|
||||||
|
</pre>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank: :dollar:
|
||||||
|
|
||||||
|
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.
|
||||||
6
docs/docs/contact.md
Normal file
6
docs/docs/contact.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
Feel free to reach out with bugs or suggestions at any of the following places:
|
||||||
|
|
||||||
|
- Message me on [Telegram](https://t.me/MisterBiggs)
|
||||||
|
- Message me on Discord `MisterBiggs#0465`
|
||||||
|
- Tweet me on [Twitter](https://twitter.com/AnsonBiggs)
|
||||||
|
- Open an issue on gitlab: [`Telegram Bot`](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot) [`Discord Bot`](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)
|
||||||
15
docs/docs/donate.md
Normal file
15
docs/docs/donate.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
Simple Stock Bot is run entirely on donations, and costs about $420 a year to run. All donations go directly towards paying for servers, and premium market data provided by [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
|
||||||
|
|
||||||
|
The best way to donate is through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) which accepts Paypal or Credit card.
|
||||||
|
|
||||||
|
Alternatively, you can donate on Telegram with the `/donate` [command](commands.md#donate-amount-in-usd).
|
||||||
|
|
||||||
|
If you have any questions get in [touch.](contact.md)
|
||||||
|
|
||||||
|
## Other Ways to Help:
|
||||||
|
|
||||||
|
- Follow me on [twitter](https://twitter.com/AnsonBiggs)
|
||||||
|
- Contribute to the project on [GitLab](https://gitlab.com/simple-stock-bots) or just leave a star
|
||||||
|
- Using my referral links to host your own Bot
|
||||||
|
- [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
|
||||||
|
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
||||||
41
docs/docs/host.md
Normal file
41
docs/docs/host.md
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
# Self Hosted Bot
|
||||||
|
|
||||||
|
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
This project runs neatly in a docker container, so all that you need to run it yourself is [Docker](https://hub.docker.com/?overlay=onboarding) installed on your system.
|
||||||
|
|
||||||
|
Depending on what platform you'll need:
|
||||||
|
|
||||||
|
- Telegram API key which can be obtained for free by talking to [BotFather](https://telegram.me/botfather), more details [here.](https://core.telegram.org/bots#3-how-do-i-create-a-bot)
|
||||||
|
- Discord API key which can be obtained for free at [https://discord.com/developers](https://discord.com/developers)
|
||||||
|
|
||||||
|
Finally, you will need a [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) API key. They offer a free tier that should be enough for any private groups, more details [here.](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
|
||||||
|
|
||||||
|
!!! tip
|
||||||
|
The bot will function without a [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) key and will fall back to only using cryptocurrency data.
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
If you want to accept donations you also need a Stripe API key and provide a `STRIPE` key to your bot. [https://stripe.com/]
|
||||||
|
|
||||||
|
## Installing
|
||||||
|
|
||||||
|
Once Docker is installed and you have your API keys for Telegram and [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) getting the bot running on any platform is extremely easy.
|
||||||
|
|
||||||
|
Download or clone the repository to your machine and open a terminal in the project and build the Docker container.
|
||||||
|
|
||||||
|
```
|
||||||
|
docker build -t simple-telegram-bot .
|
||||||
|
```
|
||||||
|
|
||||||
|
Then run the bot using your API keys.
|
||||||
|
|
||||||
|
```
|
||||||
|
docker run --detach \
|
||||||
|
-e TELEGRAM=TELEGRAM_API_KEY \
|
||||||
|
-e MARKETDATA=MARKETDATA_API_KEY \
|
||||||
|
simple-telegram-bot
|
||||||
|
```
|
||||||
|
|
||||||
|
Your bot should be running! If you are new to Docker, I would recommend checking out its documentation for full control over your bot.
|
||||||
BIN
docs/docs/img/Broadcast.png
Normal file
BIN
docs/docs/img/Broadcast.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 467 KiB |
BIN
docs/docs/img/Chat.png
Normal file
BIN
docs/docs/img/Chat.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 433 KiB |
BIN
docs/docs/img/Connect.png
Normal file
BIN
docs/docs/img/Connect.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 455 KiB |
BIN
docs/docs/img/Discord.png
Normal file
BIN
docs/docs/img/Discord.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 486 KiB |
BIN
docs/docs/img/Telegram-Canary.png
Normal file
BIN
docs/docs/img/Telegram-Canary.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 490 KiB |
BIN
docs/docs/img/Telegram.png
Normal file
BIN
docs/docs/img/Telegram.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 474 KiB |
BIN
docs/docs/img/TgChartChat.jpg
Normal file
BIN
docs/docs/img/TgChartChat.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 52 KiB |
BIN
docs/docs/img/TgIntraChat.jpg
Normal file
BIN
docs/docs/img/TgIntraChat.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 52 KiB |
29
docs/docs/index.md
Normal file
29
docs/docs/index.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
# Simple Stock Bots
|
||||||
|
|
||||||
|
Simple Stock Bots is a family of messaging bots that aim to provide simple interface to stock market information.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
The bots can either be added to a server or can be direct messaged for the exact same functionality. Links for each platform are below:
|
||||||
|
|
||||||
|
[Telegram Bot :fontawesome-brands-telegram:](https://t.me/SimpleStockBot){ .md-button .md-button--primary }
|
||||||
|
|
||||||
|
[Discord Bot :fontawesome-brands-discord:](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button .md-button--primary }
|
||||||
|
|
||||||
|
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.md)
|
||||||
|
|
||||||
|
## 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. For full information see [Commands](commands.md)
|
||||||
|
|
||||||
|
## Source Code
|
||||||
|
|
||||||
|
The source code for the bots is completely open and hosted on GitLab. The project is licensed with an MIT License which is incredibly permissive. [The full text of the license can be read here](./LICENSE)
|
||||||
|
|
||||||
|
- [Telegram Bot Source](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot)
|
||||||
|
- [Discord Bot Source](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)
|
||||||
|
|
||||||
|
If you decide to host your own bots using my source code please consider using my referral links for marketdata.app and DigitalOcean. We both get a kickback when you use them.
|
||||||
|
|
||||||
|
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
||||||
|
- [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
|
||||||
40
docs/docs/stylesheets/phone.css
Normal file
40
docs/docs/stylesheets/phone.css
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
/* 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;
|
||||||
|
margin: 50px;
|
||||||
|
}
|
||||||
|
.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;
|
||||||
|
}
|
||||||
74
docs/mkdocs.yml
Normal file
74
docs/mkdocs.yml
Normal file
@ -0,0 +1,74 @@
|
|||||||
|
site_name: Simple Stock Bot Docs
|
||||||
|
site_url: https://docs.simplestockbot.com
|
||||||
|
edit_uri: /simple-stock-bots/site/tree/master/docs
|
||||||
|
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> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>
|
||||||
|
|
||||||
|
|
||||||
|
nav:
|
||||||
|
- Home: index.md
|
||||||
|
- Commands: commands.md
|
||||||
|
- Hosting: host.md
|
||||||
|
- Donate: donate.md
|
||||||
|
- Contact: contact.md
|
||||||
|
|
||||||
|
theme:
|
||||||
|
name: material
|
||||||
|
language: en
|
||||||
|
features:
|
||||||
|
- navigation.instant
|
||||||
|
- navigation.tracking
|
||||||
|
- navigation.tabs
|
||||||
|
- navigation.tabs.sticky
|
||||||
|
- navigation.footer
|
||||||
|
icon:
|
||||||
|
logo: material/robot-love
|
||||||
|
palette:
|
||||||
|
- media: "(prefers-color-scheme: light)"
|
||||||
|
primary: green
|
||||||
|
scheme: default
|
||||||
|
toggle:
|
||||||
|
icon: material/lightbulb-outline
|
||||||
|
name: Switch to dark mode
|
||||||
|
- media: "(prefers-color-scheme: dark)"
|
||||||
|
primary: green
|
||||||
|
scheme: slate
|
||||||
|
toggle:
|
||||||
|
icon: material/lightbulb
|
||||||
|
name: Switch to light mode
|
||||||
|
|
||||||
|
extra:
|
||||||
|
social:
|
||||||
|
- icon: fontawesome/solid/house
|
||||||
|
link: https://simplestockbot.com/
|
||||||
|
- icon: fontawesome/brands/telegram
|
||||||
|
link: https://t.me/SimpleStockBot
|
||||||
|
name: Get the Telegram bot
|
||||||
|
- icon: fontawesome/brands/discord
|
||||||
|
link: https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot
|
||||||
|
name: Get the Discord Bot
|
||||||
|
- icon: material/chart-line-stacked
|
||||||
|
link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo
|
||||||
|
name: MarketData.app for stock data
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
extra_css:
|
||||||
|
- stylesheets/phone.css
|
||||||
|
|
||||||
|
|
||||||
|
plugins:
|
||||||
|
- search
|
||||||
|
- social
|
||||||
|
|
||||||
|
|
||||||
|
markdown_extensions:
|
||||||
|
- attr_list
|
||||||
|
- pymdownx.emoji:
|
||||||
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||||
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||||
5
docs/requirements.txt
Normal file
5
docs/requirements.txt
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
mkdocs-material==9.1
|
||||||
|
|
||||||
|
# Required for Social Cards
|
||||||
|
Pillow==9.5.0
|
||||||
|
CairoSVG==2.7.0
|
||||||
Loading…
x
Reference in New Issue
Block a user