diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 35e36fe..5c15710 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,6 +1,9 @@ stages: - lint + - build + - build_site - deploy + - deploy_site black: stage: lint @@ -18,4 +21,4 @@ ruff: include: - - local: /docs/.gitlab-ci.yml + - local: /site/.gitlab-ci.yml diff --git a/docs/.gitlab-ci.yml b/docs/.gitlab-ci.yml deleted file mode 100644 index aea9f4e..0000000 --- a/docs/.gitlab-ci.yml +++ /dev/null @@ -1,12 +0,0 @@ -image: python:3.11 -pages: - stage: deploy - script: - - cd ./docs - - pip install -r requirements.txt - - mkdocs build --site-dir ../public --verbose - artifacts: - paths: - - public - # rules: - # - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH' diff --git a/docs/.gitignore b/site/.gitignore similarity index 100% rename from docs/.gitignore rename to site/.gitignore diff --git a/site/.gitlab-ci.yml b/site/.gitlab-ci.yml new file mode 100644 index 0000000..5832d4b --- /dev/null +++ b/site/.gitlab-ci.yml @@ -0,0 +1,23 @@ +image: python:3.11 + +build_site: + stage: build + script: + - cd ./site + - pip install -r requirements.txt + - mkdocs build --site-dir ../public --verbose + artifacts: + paths: + - public + +deploy_site: + stage: deploy + script: + - echo "Publishing site..." + dependencies: + - build_site + artifacts: + paths: + - public + rules: + - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH' diff --git a/docs/.vscode/settings.json b/site/.vscode/settings.json similarity index 100% rename from docs/.vscode/settings.json rename to site/.vscode/settings.json diff --git a/docs/LICENSE b/site/LICENSE similarity index 100% rename from docs/LICENSE rename to site/LICENSE diff --git a/docs/docs/LICENSE.md b/site/docs/LICENSE.md similarity index 100% rename from docs/docs/LICENSE.md rename to site/docs/LICENSE.md diff --git a/site/docs/blog/.authors.yml b/site/docs/blog/.authors.yml new file mode 100644 index 0000000..6f58fcc --- /dev/null +++ b/site/docs/blog/.authors.yml @@ -0,0 +1,5 @@ +authors: + Anson: + name: Anson Biggs + description: Creator + avatar: https://gitlab.com/uploads/-/system/user/avatar/1377308/avatar.png \ No newline at end of file diff --git a/site/docs/blog/index.md b/site/docs/blog/index.md new file mode 100644 index 0000000..c58f16c --- /dev/null +++ b/site/docs/blog/index.md @@ -0,0 +1,2 @@ +# Blog + diff --git a/site/docs/blog/posts/intro.md b/site/docs/blog/posts/intro.md new file mode 100644 index 0000000..0d9ff01 --- /dev/null +++ b/site/docs/blog/posts/intro.md @@ -0,0 +1,64 @@ +--- +title: "Introducing Simple Stock Bot: Your Chat Group's Financial Whiz" +date: 2023-10-10 +tags: [Simple Stock Bot, Introduction, Telegram, Discord, Financial Insights] +authors: [Anson] +description: > + Welcome to the world of Simple Stock Bot, where real-time financial insights are integrated seamlessly into your group chats on Telegram and Discord! +--- + +## What is Simple Stock Bot? + +Simple Stock Bot is a chatbot designed to enrich your financial discussions on Telegram and Discord. Regardless of whether you're a seasoned trader or a beginner in the stock market, this bot is here to make your discussions more informative and engaging. + +
+
+
+ I wonder how $tsla is affecting the price of $$btc +
+
+ The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68% +
+
+ The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today +
+
+
+ +With Simple Stock Bot, you can: +- **Fetch Real-time Quotes**: Obtain the latest stock and cryptocurrency prices instantly within your group chat. +- **View Charts**: Delve into intraday movements or assess a month's trading data right inside your group chat. +- **Stay Updated on Market Trends**: Discover what's buzzing in the stock and crypto spheres. + +## Add the Bot to your Group + +[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } + +[:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button } + + + +## Using the Bot + +Embarking on your journey with Simple Stock Bot is effortless. Just add the bot to your Telegram or Discord group, and you're all set to dive into financial discussions right from your chat! + +Here are some simple commands to get you started: +- `/intra` to view intraday charts. +- `/chart` for a glimpse of the last month's trading data. +- `/trending` to catch up on the latest trending stocks and cryptocurrencies. + +## Keeping It Free + +Simple Stock Bot is a community-supported project, thriving on the contributions from its users. It's sustained entirely through donations to cover server costs and premium market data subscriptions, ensuring it remains free for everyone. + +Feeling generous? You can support the project by [donating](https://docs.simplestockbot.com/donate/), following on [Twitter](https://twitter.com/AnsonBiggs), or contributing on [GitLab](https://gitlab.com/simple-stock-bot). + +## Dive Deeper + +Craving more insights and features? Explore the [official documentation](https://docs.simplestockbot.com/) to uncover all the capabilities of Simple Stock Bot. + +Get ready to elevate your financial discussions with Simple Stock Bot! Your group chats will never be the same again. + +--- + +Stay tuned for more updates, tips, and financial insights brought to you by Simple Stock Bot. Here’s to making every financial discussion enriched and informed! diff --git a/docs/docs/commands.md b/site/docs/commands.md similarity index 92% rename from docs/docs/commands.md rename to site/docs/commands.md index bdb8061..d207de0 100644 --- a/docs/docs/commands.md +++ b/site/docs/commands.md @@ -1,12 +1,16 @@ Symbols are used in headings to denote what platforms and symbol types a command supports. -- Telegram Only :fontawesome-brands-telegram-plane: +- Telegram Only :fontawesome-brands-telegram: - Discord Only :fontawesome-brands-discord: - Bot Commands :robot: - Cryptocurrency Support :material-currency-btc: - Stock Market Support :bank: - OTC Support :dollar: +## Get the Bots + +[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button } + ## 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. diff --git a/docs/docs/contact.md b/site/docs/contact.md similarity index 100% rename from docs/docs/contact.md rename to site/docs/contact.md diff --git a/docs/docs/donate.md b/site/docs/donate.md similarity index 100% rename from docs/docs/donate.md rename to site/docs/donate.md diff --git a/docs/docs/host.md b/site/docs/host.md similarity index 88% rename from docs/docs/host.md rename to site/docs/host.md index 6288bd3..d86c17c 100644 --- a/docs/docs/host.md +++ b/site/docs/host.md @@ -2,6 +2,10 @@ This guide provides step-by-step instructions for setting up and running this project on your local machine, whether for development, testing, or personal use. +## Get the Bots + +[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button } + ## Pre-requisites Ensure the following are installed or obtained before proceeding: diff --git a/docs/docs/img/Broadcast.png b/site/docs/img/Broadcast.png similarity index 100% rename from docs/docs/img/Broadcast.png rename to site/docs/img/Broadcast.png diff --git a/docs/docs/img/Chat.png b/site/docs/img/Chat.png similarity index 100% rename from docs/docs/img/Chat.png rename to site/docs/img/Chat.png diff --git a/docs/docs/img/Connect.png b/site/docs/img/Connect.png similarity index 100% rename from docs/docs/img/Connect.png rename to site/docs/img/Connect.png diff --git a/docs/docs/img/Discord.png b/site/docs/img/Discord.png similarity index 100% rename from docs/docs/img/Discord.png rename to site/docs/img/Discord.png diff --git a/docs/docs/img/Telegram-Canary.png b/site/docs/img/Telegram-Canary.png similarity index 100% rename from docs/docs/img/Telegram-Canary.png rename to site/docs/img/Telegram-Canary.png diff --git a/docs/docs/img/Telegram.png b/site/docs/img/Telegram.png similarity index 100% rename from docs/docs/img/Telegram.png rename to site/docs/img/Telegram.png diff --git a/docs/docs/img/TgChartChat.jpg b/site/docs/img/TgChartChat.jpg similarity index 100% rename from docs/docs/img/TgChartChat.jpg rename to site/docs/img/TgChartChat.jpg diff --git a/docs/docs/img/TgIntraChat.jpg b/site/docs/img/TgIntraChat.jpg similarity index 100% rename from docs/docs/img/TgIntraChat.jpg rename to site/docs/img/TgIntraChat.jpg diff --git a/docs/docs/index.md b/site/docs/index.md similarity index 88% rename from docs/docs/index.md rename to site/docs/index.md index c7d3f7e..27f4085 100644 --- a/docs/docs/index.md +++ b/site/docs/index.md @@ -2,6 +2,10 @@ Discover a new level of financial discussion with Simple Stock Bot, your go-to solution for real-time stock market and cryptocurrency insights within your Telegram or Discord group chats. Transform your everyday discussions into an interactive financial exploration experience. With Simple Stock Bot, keeping up with the stock market or cryptocurrency trends has never been more seamless and engaging. +## Get the Bots + +[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button } + ## [Commands](commands.md) ### Real-Time Stock and Cryptocurrency Updates diff --git a/docs/docs/stylesheets/phone.css b/site/docs/stylesheets/phone.css similarity index 100% rename from docs/docs/stylesheets/phone.css rename to site/docs/stylesheets/phone.css diff --git a/docs/mkdocs.yml b/site/mkdocs.yml similarity index 92% rename from docs/mkdocs.yml rename to site/mkdocs.yml index 3693379..e28dbfa 100644 --- a/docs/mkdocs.yml +++ b/site/mkdocs.yml @@ -1,6 +1,6 @@ site_name: Simple Stock Bot site_url: https://simplestockbot.com -edit_uri: /simple-stock-bots/site/tree/master/docs +edit_uri: /simple-stock-bots/site/tree/master/site repo_url: https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot repo_name: Simple Stock Bots @@ -15,6 +15,7 @@ nav: - Self-Host: host.md - Donate: donate.md - Contact: contact.md + - Blog: /blog theme: name: material @@ -65,6 +66,7 @@ extra_css: plugins: - search - social + - blog markdown_extensions: diff --git a/docs/requirements.txt b/site/requirements.txt similarity index 100% rename from docs/requirements.txt rename to site/requirements.txt