summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDisorder AA <disorrder@gmail.com>2024-05-10 13:17:15 +0200
committerGitHub <noreply@github.com>2024-05-10 11:17:15 +0000
commit5bd4ae0856a228df1af47f87cc1d15c799e53e72 (patch)
tree4864402318c0babd9492ae95a5a6f10b81214709
parent83476ada465dbb3fd249922859ef11621a3e313e (diff)
[Docs] Upgrade Docusaurus to v3 (#6386)
* da3: minor updates * da3: upgrade react 18 * da3: fix md content * da3: upgrade docusaurus 3, fix math in tables * da3: fix DocSearch * put search back * da3: fix details / summary --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
-rw-r--r--website/babel.config.cjs (renamed from website/babel.config.js)0
-rw-r--r--website/content/bot/faqs.md68
-rw-r--r--website/content/bot/usage/telegram.md47
-rw-r--r--website/content/excel/data-connectors.md15
-rw-r--r--website/content/excel/getting-started/basics.md30
-rw-r--r--website/content/excel/help.md43
-rw-r--r--website/content/platform/development/how-to/add_data_provider_extension.md70
-rw-r--r--website/content/platform/development/how-to/add_endpoint_to_existing_provider.md155
-rw-r--r--website/content/platform/development/tests.md39
-rw-r--r--website/content/platform/faqs/data_providers.md37
-rw-r--r--website/content/sdk/data-available/crypto/discovery.md139
-rw-r--r--website/content/sdk/data-available/crypto/index.md29
-rw-r--r--website/content/sdk/data-available/etf.md122
-rw-r--r--website/content/sdk/faqs/bugs_support_feedback.md33
-rw-r--r--website/content/sdk/faqs/data_sources.md37
-rw-r--r--website/content/sdk/faqs/developer_issues.md48
-rw-r--r--website/content/sdk/faqs/general_operation.md58
-rw-r--r--website/content/sdk/faqs/import_errors.md40
-rw-r--r--website/content/sdk/faqs/installation_updates.md44
-rw-r--r--website/content/sdk/reference/alt/oss/ross.md49
-rw-r--r--website/content/sdk/reference/alt/oss/search.md35
-rw-r--r--website/content/sdk/reference/alt/oss/top.md65
-rw-r--r--website/content/sdk/reference/crypto/dd/binance_available_quotes_for_each_coin.md26
-rw-r--r--website/content/sdk/reference/crypto/dd/trading_pairs.md70
-rw-r--r--website/content/sdk/reference/crypto/defi/anchor_data.md54
-rw-r--r--website/content/sdk/reference/crypto/defi/aterra.md48
-rw-r--r--website/content/sdk/reference/crypto/disc/gainers.md52
-rw-r--r--website/content/sdk/reference/crypto/disc/losers.md46
-rw-r--r--website/content/sdk/reference/crypto/ov/cr.md48
-rw-r--r--website/content/sdk/reference/crypto/ov/crypto_hacks.md46
-rw-r--r--website/content/sdk/reference/portfolio/po/blacklitterman.md70
-rw-r--r--website/content/sdk/reference/portfolio/po/hcp.md75
-rw-r--r--website/content/sdk/reference/portfolio/po/hcp.mdx76
-rw-r--r--website/content/sdk/reference/portfolio/po/herc.md95
-rw-r--r--website/content/sdk/reference/portfolio/po/herc.mdx97
-rw-r--r--website/content/sdk/reference/portfolio/po/hrp.md96
-rw-r--r--website/content/sdk/reference/portfolio/po/hrp.mdx98
-rw-r--r--website/content/sdk/reference/portfolio/po/nco.md97
-rw-r--r--website/content/sdk/reference/portfolio/po/nco.mdx99
-rw-r--r--website/content/sdk/usage/api-keys.md85
-rw-r--r--website/content/terminal/faqs/bugs_support_feedback.md31
-rw-r--r--website/content/terminal/faqs/data_sources.md35
-rw-r--r--website/content/terminal/faqs/developer_issues.md56
-rw-r--r--website/content/terminal/faqs/general_operation.md57
-rw-r--r--website/content/terminal/faqs/installation_updates.md42
-rw-r--r--website/content/terminal/faqs/launching.md45
-rw-r--r--website/content/terminal/installation/macos.md43
-rw-r--r--website/content/terminal/installation/source.md75
-rw-r--r--website/content/terminal/installation/windows.md18
-rw-r--r--website/content/terminal/reference/alt/oss/rossidx.md45
-rw-r--r--website/content/terminal/reference/alt/oss/tr.md29
-rw-r--r--website/content/terminal/reference/crypto/disc/dapps.md43
-rw-r--r--website/content/terminal/reference/crypto/disc/dex.md31
-rw-r--r--website/content/terminal/reference/crypto/disc/gainers.md33
-rw-r--r--website/content/terminal/reference/crypto/disc/games.md39
-rw-r--r--website/content/terminal/reference/crypto/disc/losers.md41
-rw-r--r--website/content/terminal/reference/crypto/disc/nft.md29
-rw-r--r--website/content/terminal/reference/crypto/ov/ch.md43
-rw-r--r--website/content/terminal/reference/crypto/ov/cr.md31
-rw-r--r--website/content/terminal/usage/data/api-keys.md87
-rw-r--r--website/content/terminal/usage/outputs/interactive-charts.md31
-rw-r--r--website/content/terminal/usage/outputs/interactive-tables.md33
-rw-r--r--website/docusaurus.config.js129
-rw-r--r--website/docusaurus.config.ts105
-rw-r--r--website/package-lock.json11907
-rw-r--r--website/package.json56
-rw-r--r--website/pnpm-lock.yaml9371
-rw-r--r--website/sidebars.js7
-rw-r--r--website/src/pages/index.tsx20
-rw-r--r--website/src/theme/CodeBlock/Content/String.js37
-rw-r--r--website/src/theme/ColorModeToggle/index.js20
-rw-r--r--website/src/theme/DocSidebarItem/Category/index.js28
-rw-r--r--website/src/theme/DocSidebarItem/index.js10
-rw-r--r--website/src/theme/Footer/index.js16
-rw-r--r--website/src/theme/Navbar/Content/index.js14
-rw-r--r--website/src/theme/Navbar/Layout/index.js40
-rw-r--r--website/src/theme/NotFound.js4
-rw-r--r--website/src/theme/SearchBar/index.js52
-rw-r--r--website/tailwind.config.ts (renamed from website/tailwind.config.js)12
-rw-r--r--website/tsconfig.json2
-rw-r--r--website/yarn.lock8432
81 files changed, 9284 insertions, 24376 deletions
diff --git a/website/babel.config.js b/website/babel.config.cjs
index e00595dae7d..e00595dae7d 100644
--- a/website/babel.config.js
+++ b/website/babel.config.cjs
diff --git a/website/content/bot/faqs.md b/website/content/bot/faqs.md
index ce75ebafd83..b4fb0ef4d0a 100644
--- a/website/content/bot/faqs.md
+++ b/website/content/bot/faqs.md
@@ -1,79 +1,86 @@
---
title: FAQs
sidebar_position: 5
-description: This page offers information about OpenBB Bot, covering topics such as
+description:
+ This page offers information about OpenBB Bot, covering topics such as
linking your OpenBB Bot account, trying an OpenBB Bot plan, automatic plan renewals,
refunds, access on different platforms, individual and server plans, and troubleshooting
issues with slash commands.
keywords:
-- OpenBB Bot
-- OpenBB Bot account
-- OpenBB plan
-- billing cycle
-- OpenBB Discord
-- server settings
-- integrations
-- refunds
-- subscription
-- individual plan
-- server plan
-- slash commands
+ - OpenBB Bot
+ - OpenBB Bot account
+ - OpenBB plan
+ - billing cycle
+ - OpenBB Discord
+ - server settings
+ - integrations
+ - refunds
+ - subscription
+ - individual plan
+ - server plan
+ - slash commands
---
-import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
+import HeadTitle from "@site/src/components/General/HeadTitle.tsx";
<HeadTitle title="FAQs | OpenBB Bot Docs" />
-<details><summary>How Do I Link My OpenBB Bot Account?</summary>
+<details>
+<summary mdxType="summary">How Do I Link My OpenBB Bot Account?</summary>
After you signup for an OpenBB Bot plan you can link your accounts from <a href="https://my.openbb.co/app/bot" class="_hyper-link">here</a>
</details>
-<details><summary>Can I try an OpenBB Bot plan?</summary>
+<details>
+<summary mdxType="summary">Can I try an OpenBB Bot plan?</summary>
You can try a preview of any plan by just running commands on a server that has OpenBB Bot, like <a href='https://my.openbb.co/discord' class='_hyper-link'>OpenBB Discord</a>. We offer a limited amount of daily commands.
</details>
-
-<details><summary>Will my OpenBB Bot plan renew at the end of the billing cycle?</summary>
+<details>
+<summary mdxType="summary">Will my OpenBB Bot plan renew at the end of the billing cycle?</summary>
Yes, plans renew automatically at the end of the monthly and yearly billing cycles. You can cancel your plan at any time, before the end of the billing cycle, and it will not auto-renew anymore.
</details>
-
-<details><summary>Can I get a refund on my OpenBB Bot?</summary>
+<details>
+<summary mdxType="summary">Can I get a refund on my OpenBB Bot?</summary>
Since we offer a free command tier to try commands we don't offer refunds as you have had ample time to try the service and make a decision.
</details>
-
-<details><summary>If I sign up for OpenBB Bot do I get access on all platforms?</summary>
+<details>
+<summary mdxType="summary">If I sign up for OpenBB Bot do I get access on all platforms?</summary>
Yes! You will have access on Discord, and other platforms as we add support.
</details>
-<details><summary>If I cancel OpenBB Bot subscription do I still have access?</summary>
+<details>
+<summary mdxType="summary">If I cancel OpenBB Bot subscription do I still have access?</summary>
No, you will lose your access but you get a credit on your account of the prorated amount until the end of your current billing cycle.
</details>
-
-<details><summary>What's the difference between an individual plan and server plan on OpenBB Bot?</summary>
+<details>
+<summary mdxType="summary">What's the difference between an individual plan and server plan on OpenBB Bot?</summary>
An individual plan gives your account access to OpenBB Bot while a server plan gives the whole server access. An individual plan carries more perks with it than a server plan, which you can find by clicking on the plan.
</details>
+<details>
+<summary mdxType="summary">I added the bot but still don't see slash commands, what do I do?</summary>
-<details><summary>I added the bot but still don't see slash commands, what do I do?</summary>
-
-<img class="mb-8" src="https://assets-global.website-files.com/5f9072399b2640f14d6a2bf4/625ddbedd330d37960463537_Untitled.png" />
+<img
+ class="mb-8"
+ src="https://assets-global.website-files.com/5f9072399b2640f14d6a2bf4/625ddbedd330d37960463537_Untitled.png"
+/>
Just head to <b>Server Settings → Integrations</b> and then <b>click ‘Manage’ next to an app</b>, where you will behold a new, shiny, and dare we say <i>dazzling</i>, new surface.
@@ -83,8 +90,11 @@ Just head to <b>Server Settings → Integrations</b> and then <b>click ‘Manage
</ul>
There’s also a command-specific list, where you can make customized permissions for each command.
+
<ul class="list-disc my-4 ml-4">
- <li>By default, these are all synced to the command permission at the top.</li>
+ <li>
+ By default, these are all synced to the command permission at the top.
+ </li>
<li>You can unsync an individual command to make further customizations.</li>
</ul>