diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 68fa97d4aad..d3e8ccea8e5 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -6,9 +6,11 @@ on: - main - release/* pull_request: - types: [closed] - branches: - - develop + pull_request: + types: [opened, synchronize, reopened] + branches: + - develop + - 'docs/*' concurrency: group: ${{ github.workflow }}-${{ github.ref }} @@ -64,7 +66,12 @@ jobs: source $VENV pip uninstall Brotli -y pytest tests/website --autodoc - python website/generate_platform_v4_markdown.py && website/generate_sdk_v3_markdown.py && python website/generate_terminal_v3_markdown.py + python website/generate_sdk_v3_markdown.py + python website/generate_terminal_v3_markdown.py + pip install -U poetry + python openbb_platform/dev_install.py -e all + pip uninstall nbmake -y + python website/generate_platform_v4_markdown.py - name: Setup Node uses: actions/setup-node@v3 diff --git a/website/content/bot/reference/discord/options/chains.md b/website/content/bot/reference/discord/options/chains.md index 55083b3bb5d..c66b3269527 100644 --- a/website/content/bot/reference/discord/options/chains.md +++ b/website/content/bot/reference/discord/options/chains.md @@ -1,9 +1,9 @@ --- title: chains -description: "This docusaurus page explores the 'chains' command which allows users\ - \ to view Options Chains by Expiry for a specific stock. It also explains several\ - \ parameters such as Stock Ticker, Expiration Date, type of options \u2013 Calls\ - \ or Puts, and Strike Prices." +description: This docusaurus page explores the `chains` command which allows users + to view Options Chains by Expiry for a specific stock. It also explains several + parameters such as Stock Ticker, Expiration Date, type of options Calls + or Puts, and Strike Prices. keywords: - Options Chains by Expiry - Stock Ticker diff --git a/website/content/bot/reference/discord/screeners/pm.md b/website/content/bot/reference/discord/screeners/pm.md index cba14ba4da4..90d5038586b 100644 --- a/website/content/bot/reference/discord/screeners/pm.md +++ b/website/content/bot/reference/discord/screeners/pm.md @@ -1,8 +1,8 @@ --- title: pm -description: "Our tool offers the ability to view the top pre-market gainers, losers,\ - \ and most active. This page will guide you on how to use the pm command to have\ - \ a better understanding of the market\u2019s movements before it officially opens." +description: Our tool offers the ability to view the top pre-market gainers, losers, + and most active. This page will guide you on how to use the pm command to have + a better understanding of the market's movements before it officially opens. keywords: - Pre-Market Top Gainers - Pre-Market Top Losers diff --git a/website/content/bot/reference/telegram/flow/flowsum/wk.md b/website/content/bot/reference/telegram/flow/flowsum/wk.md index 5e64f977427..77f0c3481da 100644 --- a/website/content/bot/reference/telegram/flow/flowsum/wk.md +++ b/website/content/bot/reference/telegram/flow/flowsum/wk.md @@ -1,9 +1,9 @@ --- title: wk -description: "This page provides the documentation of 'flowsum wk' command. It explains\ - \ how to retrieve the top flow per week for Calls and Puts by stock for understanding\ - \ the market\u2019s sentiment towards a certain stock. Parameters and usage are\ - \ clearly detailed." +description: This page provides the documentation of `flowsum wk` command. It explains + how to retrieve the top flow per week for Calls and Puts by stock for understanding + the market's sentiment towards a certain stock. Parameters and usage are + clearly detailed. keywords: - flowsum wk - stock market sentiment diff --git a/website/content/platform/development/contributor-guidelines/expecations_for_contributors.md b/website/content/platform/development/contributor-guidelines/expecations_for_contributors.md index 82e7f2acb3c..4746d8a82ea 100644 --- a/website/content/platform/development/contributor-guidelines/expecations_for_contributors.md +++ b/website/content/platform/development/contributor-guidelines/expecations_for_contributors.md @@ -42,4 +42,4 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; 6. Collaboration: - Engage actively with the OpenBB development team to ensure that your contributions align with the platform's roadmap and standards. - - Welcome feedback and be open to making revisions based on reviews and suggestions from the community. \ No newline at end of file + - Welcome feedback and be open to making revisions based on reviews and suggestions from the community. diff --git a/website/content/platform/reference/corporate/moody.md b/website/content/platform/reference/corporate/moody.md index 1bd77bd2858..41bf6f0f3ee 100644 --- a/website/content/platform/reference/corporate/moody.md +++ b/website/content/platform/reference/corporate/moody.md @@ -2,7 +2,7 @@ title: moody description: Explore and analyze the Moody Corporate Bond Index and Moody's Aaa and Baa investment bonds. Find the performance, rating, and interest rate information. - Use the `moody()` function in Python to retrieve the data with customizable parameters. + Use the ``moody()`` function in Python to retrieve the data with customizable parameters. keywords: - Moody Corporate Bond Index - Moody's Aaa @@ -113,4 +113,3 @@ OBBject - diff --git a/website/content/platform/reference/fundamental/income_growth.md b/website/content/platform/reference/fundamental/income_growth.md index 6f3494bf406..89740a14e7c 100644 --- a/website/content/platform/reference/fundamental/income_growth.md +++ b/website/content/platform/reference/fundamental/income_growth.md @@ -136,4 +136,3 @@ OBBject - diff --git a/website/content/platform/reference/quantitative/skewness.md b/website/content/platform/reference/quantitative/skewness.md index 75a1d757d26..33fe9c5a4b0 100644 --- a/website/content/platform/reference/quantitative/skewness.md +++ b/website/content/platform/reference/quantitative/skewness.md @@ -55,4 +55,3 @@ This function does not take standardized parameters. This function does not return a standardized model --- - diff --git a/website/content/platform/reference/rate/estr.md b/website/content/platform/reference/rate/estr.md index 6ecd0a95859..4045ecf3df7 100644 --- a/website/content/platform/reference/rate/estr.md +++ b/website/content/platform/reference/rate/estr.md @@ -1,15 +1,15 @@ --- title: estr -description: "Learn about the euro short-term rate (\u20ACSTR), wholesale euro unsecured\ - \ overnight borrowing costs, TARGET2 business day transactions, parameters for the\ - \ Python obb.fixedincome.rate.estr method, and the data and returns provided." +description: Learn about the euro short-term rate ($ACSTR), wholesale euro unsecured + overnight borrowing costs, TARGET2 business day transactions, parameters for the + Python obb.fixedincome.rate.estr method, and the data and returns provided. keywords: - euro short-term rate -- "\u20ACSTR" +- $ACSTR - wholesale euro unsecured overnight borrowing costs - TARGET2 business day - transactions -- "arm\u2019s length" +- arm's length - market rates - Python obb.fixedincome.rate.estr - parameters diff --git a/website/content/platform/reference/sec/symbol_map.md b/website/content/platform/reference/sec/symbol_map.md index 28fbc0d16bf..6492aa7bfb4 100644 --- a/website/content/platform/reference/sec/symbol_map.md +++ b/website/content/platform/reference/sec/symbol_map.md @@ -1,6 +1,6 @@ --- title: symbol_map -description: Retrieve the ticker symbol corresponding to a company's CIK using the +description: Retrieve the ticker symbol corresponding to a company CIK using the OBB API endpoint. This function allows you to perform a search query and get the results along with additional metadata, warnings, and optional chart data. keywords: @@ -88,4 +88,3 @@ OBBject - diff --git a/website/content/platform/usage/index.md b/website/content/platform/usage/index.md index 1d172c09040..360f73186bb 100644 --- a/website/content/platform/usage/index.md +++ b/website/content/platform/usage/index.md @@ -1,9 +1,7 @@ --- title: Overview sidebar_position: 1 -description: An overview for getting started with the OpenBB Platform's Python client and Fast API; details - on authorization, data providers, settings, responses, commands, logging, and features - such as dynamic command execution. +description: An overview for getting started with the OpenBB Platform Python client and Fast API, details on authorization, data providers, settings, responses, commands, logging, and features such as dynamic command execution. keywords: - OpenBB Platform - Python client diff --git a/website/content/pro/widgets-library/economy/economic_calendar.md b/website/content/pro/widgets-library/economy/economic_calendar.md new file mode 100644 index 00000000000..d843200967e --- /dev/null +++ b/website/content/pro/widgets-library/economy/economic_calendar.md @@ -0,0 +1,25 @@ +--- +title: Economic Calendar +description: Economic events from the global economy +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Economic Calendar +- economy +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Economic events from the global economy. + +Source: tradingeconomics + diff --git a/website/content/pro/widgets-library/equity/analyst_estimates.md b/website/content/pro/widgets-library/equity/analyst_estimates.md new file mode 100644 index 00000000000..74074e4309f --- /dev/null +++ b/website/content/pro/widgets-library/equity/analyst_estimates.md @@ -0,0 +1,25 @@ +--- +title: Analyst Estimates +description: Analyst Estimates for a certain ticker Quarterly and Annual +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Analyst Estimates +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Analyst Estimates for a certain ticker Quarterly and Annual. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/analyst_price_target.md b/website/content/pro/widgets-library/equity/analyst_price_target.md new file mode 100644 index 00000000000..ddfc526f799 --- /dev/null +++ b/website/content/pro/widgets-library/equity/analyst_price_target.md @@ -0,0 +1,25 @@ +--- +title: Price Target By Analyst +description: Analyst Price Targets for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Price Target By Analyst +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Analyst Price Targets for a certain ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/analyst_upgrades_downgrades.md b/website/content/pro/widgets-library/equity/analyst_upgrades_downgrades.md new file mode 100644 index 00000000000..31211efb09f --- /dev/null +++ b/website/content/pro/widgets-library/equity/analyst_upgrades_downgrades.md @@ -0,0 +1,25 @@ +--- +title: Analyst Upgrades and Downgrades +description: Analyst Upgrades and Downgrades for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Analyst Upgrades and Downgrades +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Analyst Upgrades and Downgrades for a certain ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/balance_sheet.md b/website/content/pro/widgets-library/equity/balance_sheet.md new file mode 100644 index 00000000000..18a8d1d6278 --- /dev/null +++ b/website/content/pro/widgets-library/equity/balance_sheet.md @@ -0,0 +1,25 @@ +--- +title: Balance Sheet +description: Balance Sheet for a certain ticker Quarterly and Annual +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Balance Sheet +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Balance Sheet for a certain ticker Quarterly and Annual. + +Source: intrinio + diff --git a/website/content/pro/widgets-library/equity/cash_flow_statement.md b/website/content/pro/widgets-library/equity/cash_flow_statement.md new file mode 100644 index 00000000000..ef59961e38e --- /dev/null +++ b/website/content/pro/widgets-library/equity/cash_flow_statement.md @@ -0,0 +1,25 @@ +--- +title: Cash Flow Statement +description: Cash Flow Statement for a certain ticker Quarterly and Annual +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Cash Flow Statement +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Cash Flow Statement for a certain ticker Quarterly and Annual. + +Source: intrinio + diff --git a/website/content/pro/widgets-library/equity/charting.md b/website/content/pro/widgets-library/equity/charting.md new file mode 100644 index 00000000000..19564edd9b5 --- /dev/null +++ b/website/content/pro/widgets-library/equity/charting.md @@ -0,0 +1,25 @@ +--- +title: Charting +description: Show charting +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Charting +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show charting. + +Source: fmp,intrinio,fred + diff --git a/website/content/pro/widgets-library/equity/company_events.md b/website/content/pro/widgets-library/equity/company_events.md new file mode 100644 index 00000000000..32fb1973f1c --- /dev/null +++ b/website/content/pro/widgets-library/equity/company_events.md @@ -0,0 +1,25 @@ +--- +title: Earnings History +description: Earnings History for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Earnings History +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Earnings History for a certain ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/company_news.md b/website/content/pro/widgets-library/equity/company_news.md new file mode 100644 index 00000000000..3eb02ed6028 --- /dev/null +++ b/website/content/pro/widgets-library/equity/company_news.md @@ -0,0 +1,25 @@ +--- +title: Company News +description: Show company news for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Company News +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show company news for a certain ticker. + +Source: benzinga + diff --git a/website/content/pro/widgets-library/equity/company_profile.md b/website/content/pro/widgets-library/equity/company_profile.md new file mode 100644 index 00000000000..9bec4166894 --- /dev/null +++ b/website/content/pro/widgets-library/equity/company_profile.md @@ -0,0 +1,25 @@ +--- +title: Company profile +description: Show company profile for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Company profile +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show company profile for a certain ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/earnings_transcripts.md b/website/content/pro/widgets-library/equity/earnings_transcripts.md new file mode 100644 index 00000000000..8b95e955866 --- /dev/null +++ b/website/content/pro/widgets-library/equity/earnings_transcripts.md @@ -0,0 +1,25 @@ +--- +title: Earnings Transcripts +description: Full transcript of earnings call +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Earnings Transcripts +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Full transcript of earnings call. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/equity_select.md b/website/content/pro/widgets-library/equity/equity_select.md new file mode 100644 index 00000000000..55ef57c7c13 --- /dev/null +++ b/website/content/pro/widgets-library/equity/equity_select.md @@ -0,0 +1,25 @@ +--- +title: Ticker Information +description: Ticker Information +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Ticker Information +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Ticker Information. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/financial_ratios.md b/website/content/pro/widgets-library/equity/financial_ratios.md new file mode 100644 index 00000000000..f906b3711b2 --- /dev/null +++ b/website/content/pro/widgets-library/equity/financial_ratios.md @@ -0,0 +1,25 @@ +--- +title: Financial Ratios +description: Show financial ratios for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Financial Ratios +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show financial ratios for a certain ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/financial_statements.md b/website/content/pro/widgets-library/equity/financial_statements.md new file mode 100644 index 00000000000..154a5cee72b --- /dev/null +++ b/website/content/pro/widgets-library/equity/financial_statements.md @@ -0,0 +1,25 @@ +--- +title: Financial Statements +description: Balance sheet, Income Statement, Cashflow Statement +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Financial Statements +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Balance sheet, Income Statement, Cashflow Statement. + +Source: intrinio + diff --git a/website/content/pro/widgets-library/equity/global_news.md b/website/content/pro/widgets-library/equity/global_news.md new file mode 100644 index 00000000000..2f72005b893 --- /dev/null +++ b/website/content/pro/widgets-library/equity/global_news.md @@ -0,0 +1,25 @@ +--- +title: Global News +description: Show news from around the world +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Global News +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show news from around the world. + +Source: benzinga + diff --git a/website/content/pro/widgets-library/equity/grouped_comparison.md b/website/content/pro/widgets-library/equity/grouped_comparison.md new file mode 100644 index 00000000000..fda042c8465 --- /dev/null +++ b/website/content/pro/widgets-library/equity/grouped_comparison.md @@ -0,0 +1,25 @@ +--- +title: Comparison Analysis +description: Compare multiple tickers +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Comparison Analysis +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Compare multiple tickers. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/income_statement.md b/website/content/pro/widgets-library/equity/income_statement.md new file mode 100644 index 00000000000..e3f1d519a84 --- /dev/null +++ b/website/content/pro/widgets-library/equity/income_statement.md @@ -0,0 +1,25 @@ +--- +title: Income Statement +description: Income Statement for a certain ticker Quarterly and Annual +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Income Statement +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Income Statement for a certain ticker Quarterly and Annual. + +Source: intrinio + diff --git a/website/content/pro/widgets-library/equity/insider_trading.md b/website/content/pro/widgets-library/equity/insider_trading.md new file mode 100644 index 00000000000..6ef14dbb401 --- /dev/null +++ b/website/content/pro/widgets-library/equity/insider_trading.md @@ -0,0 +1,25 @@ +--- +title: Insider Trading +description: Recent Insider Trading +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Insider Trading +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Recent Insider Trading. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/institutional_ownership.md b/website/content/pro/widgets-library/equity/institutional_ownership.md new file mode 100644 index 00000000000..245741aa3c5 --- /dev/null +++ b/website/content/pro/widgets-library/equity/institutional_ownership.md @@ -0,0 +1,25 @@ +--- +title: Institutional Ownership +description: Instutional Ownership quarterly +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Institutional Ownership +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Instutional Ownership quarterly. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/key_metrics.md b/website/content/pro/widgets-library/equity/key_metrics.md new file mode 100644 index 00000000000..0f0da9b1a6e --- /dev/null +++ b/website/content/pro/widgets-library/equity/key_metrics.md @@ -0,0 +1,25 @@ +--- +title: Key Metrics +description: Key Metrics for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Key Metrics +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Key Metrics for a certain ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/management_team.md b/website/content/pro/widgets-library/equity/management_team.md new file mode 100644 index 00000000000..d086f57e992 --- /dev/null +++ b/website/content/pro/widgets-library/equity/management_team.md @@ -0,0 +1,25 @@ +--- +title: Management Team +description: Management Team for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Management Team +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Management Team for a certain ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/market_overview.md b/website/content/pro/widgets-library/equity/market_overview.md new file mode 100644 index 00000000000..6114afa66ce --- /dev/null +++ b/website/content/pro/widgets-library/equity/market_overview.md @@ -0,0 +1,25 @@ +--- +title: Market Indices +description: Show market overview (SP500, Nasdaq, Gold, ...) +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Market Indices +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show market overview (SP500, Nasdaq, Gold, ...). + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/price_performance.md b/website/content/pro/widgets-library/equity/price_performance.md new file mode 100644 index 00000000000..63392c3b6bf --- /dev/null +++ b/website/content/pro/widgets-library/equity/price_performance.md @@ -0,0 +1,25 @@ +--- +title: Price performance +description: Show price performance for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Price performance +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show price performance for a certain ticker. + +Source: intrinio + diff --git a/website/content/pro/widgets-library/equity/price_target.md b/website/content/pro/widgets-library/equity/price_target.md new file mode 100644 index 00000000000..bf6e65e3981 --- /dev/null +++ b/website/content/pro/widgets-library/equity/price_target.md @@ -0,0 +1,25 @@ +--- +title: Price Target +description: Price Targets for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Price Target +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Price Targets for a certain ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/revenue_per_bus_line.md b/website/content/pro/widgets-library/equity/revenue_per_bus_line.md new file mode 100644 index 00000000000..aa3adbf7915 --- /dev/null +++ b/website/content/pro/widgets-library/equity/revenue_per_bus_line.md @@ -0,0 +1,25 @@ +--- +title: Revenue Per Business Line +description: Revenue Per Business Line Quarterly and Annual +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Revenue Per Business Line +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Revenue Per Business Line Quarterly and Annual. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/revenue_per_geography.md b/website/content/pro/widgets-library/equity/revenue_per_geography.md new file mode 100644 index 00000000000..59d2b310458 --- /dev/null +++ b/website/content/pro/widgets-library/equity/revenue_per_geography.md @@ -0,0 +1,25 @@ +--- +title: Revenue Per Geography +description: Revenue Per Geography Quarterly and Annual +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Revenue Per Geography +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Revenue Per Geography Quarterly and Annual. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/sec_filings.md b/website/content/pro/widgets-library/equity/sec_filings.md new file mode 100644 index 00000000000..6949e91159f --- /dev/null +++ b/website/content/pro/widgets-library/equity/sec_filings.md @@ -0,0 +1,25 @@ +--- +title: SEC Filings +description: Recent SEC Filings for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- SEC Filings +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Recent SEC Filings for a certain ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/share_statistics.md b/website/content/pro/widgets-library/equity/share_statistics.md new file mode 100644 index 00000000000..ca8d1cee642 --- /dev/null +++ b/website/content/pro/widgets-library/equity/share_statistics.md @@ -0,0 +1,25 @@ +--- +title: Share Statistics +description: Show share statistics for a certain ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Share Statistics +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show share statistics for a certain ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/stock_dividends.md b/website/content/pro/widgets-library/equity/stock_dividends.md new file mode 100644 index 00000000000..6fe9a194299 --- /dev/null +++ b/website/content/pro/widgets-library/equity/stock_dividends.md @@ -0,0 +1,25 @@ +--- +title: Dividend Payment +description: History of stock dividends +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Dividend Payment +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +History of stock dividends. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/stock_ownership.md b/website/content/pro/widgets-library/equity/stock_ownership.md new file mode 100644 index 00000000000..47652c243b9 --- /dev/null +++ b/website/content/pro/widgets-library/equity/stock_ownership.md @@ -0,0 +1,25 @@ +--- +title: Stock Ownership +description: Instutional Ownership by percentage for a ticker +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Stock Ownership +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Instutional Ownership by percentage for a ticker. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/stock_splits.md b/website/content/pro/widgets-library/equity/stock_splits.md new file mode 100644 index 00000000000..2c8ec2af8c0 --- /dev/null +++ b/website/content/pro/widgets-library/equity/stock_splits.md @@ -0,0 +1,25 @@ +--- +title: Stock Splits +description: History of stock splits +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Stock Splits +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +History of stock splits. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/valuation_multiples.md b/website/content/pro/widgets-library/equity/valuation_multiples.md new file mode 100644 index 00000000000..7c78db37d43 --- /dev/null +++ b/website/content/pro/widgets-library/equity/valuation_multiples.md @@ -0,0 +1,25 @@ +--- +title: Valuation Multiples +description: Vaulation Multiples Annually and Quarterly +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Valuation Multiples +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Vaulation Multiples Annually and Quarterly. + +Source: fmp + diff --git a/website/content/pro/widgets-library/equity/watchlist.md b/website/content/pro/widgets-library/equity/watchlist.md new file mode 100644 index 00000000000..f82953db515 --- /dev/null +++ b/website/content/pro/widgets-library/equity/watchlist.md @@ -0,0 +1,25 @@ +--- +title: Watchlist +description: Show watchlist for one or more tickers +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Watchlist +- equity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show watchlist for one or more tickers. + +Source: fmp,intrinio + diff --git a/website/content/pro/widgets-library/ui/navigation_bar.md b/website/content/pro/widgets-library/ui/navigation_bar.md new file mode 100644 index 00000000000..6d6c5a51c8a --- /dev/null +++ b/website/content/pro/widgets-library/ui/navigation_bar.md @@ -0,0 +1,25 @@ +--- +title: Navigation Bar +description: Create inner tabs inside a tab +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Navigation Bar +- ui +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Create inner tabs inside a tab. + + + diff --git a/website/content/pro/widgets-library/utilities/clock.md b/website/content/pro/widgets-library/utilities/clock.md new file mode 100644 index 00000000000..061251cf093 --- /dev/null +++ b/website/content/pro/widgets-library/utilities/clock.md @@ -0,0 +1,22 @@ +--- +title: Clock +description: Show a clock +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Clock +- utilities +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show a clock. diff --git a/website/content/pro/widgets-library/utilities/external_table.md b/website/content/pro/widgets-library/utilities/external_table.md new file mode 100644 index 00000000000..715f2b43168 --- /dev/null +++ b/website/content/pro/widgets-library/utilities/external_table.md @@ -0,0 +1,22 @@ +--- +title: External Table +description: Show a table loaded from external source +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- External Table +- utilities +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Show a table loaded from external source. diff --git a/website/content/pro/widgets-library/utilities/rich_note.md b/website/content/pro/widgets-library/utilities/rich_note.md new file mode 100644 index 00000000000..66b9b8c1217 --- /dev/null +++ b/website/content/pro/widgets-library/utilities/rich_note.md @@ -0,0 +1,22 @@ +--- +title: Text Widget +description: Create a text widget +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- Text Widget +- utilities +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +Create a text widget. diff --git a/website/content/pro/widgets-library/utilities/rss_viewer.md b/website/content/pro/widgets-library/utilities/rss_viewer.md new file mode 100644 index 00000000000..4780669f777 --- /dev/null +++ b/website/content/pro/widgets-library/utilities/rss_viewer.md @@ -0,0 +1,22 @@ +--- +title: RSS Viewer +description: View RSS feeds +keywords: +- OpenBB +- Terminal Pro +- Investment Research +- Widgets +- RSS Viewer +- utilities +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro Widgets Library + +View RSS feeds. diff --git a/website/content/pro/widgets/chat-with-widget.md b/website/content/pro/widgets/chat-with-widget.md index b555a3ee7c9..116078d4d19 100644 --- a/website/content/pro/widgets/chat-with-widget.md +++ b/website/content/pro/widgets/chat-with-widget.md @@ -1,7 +1,7 @@ --- title: Chat with widgets sidebar_position: 0 -description: Learn about OpenBB Terminal Pro's innovative feature, the Chat Widget. +description: Learn about OpenBB Terminal Pro innovative feature, the Chat Widget. This generative AI tool enhances efficiency and productivity in investment research by offering direct data interaction. keywords: diff --git a/website/content/sdk/data-available/crypto/discovery.md b/website/content/sdk/data-available/crypto/discovery.md index 1488fb5b04a..ffad6ef7d43 100644 --- a/website/content/sdk/data-available/crypto/discovery.md +++ b/website/content/sdk/data-available/crypto/discovery.md @@ -2,7 +2,7 @@ title: Discovery sidebar_position: 2 description: This page provides detailed instructions on how to use the Discovery - sub-module within the 'openbb.crypto.disc' to find new trends in Crypto markets. + sub-module within the ''openbb.crypto.disc'' to find new trends in Crypto markets. The module enables users to search coins on CoinGecko by category, access a list of coins available on CoinGecko, search CoinPaprika, view top coins, DeFi applications, NFTs, and games by daily volume and users, and more. It also provides examples in diff --git a/website/content/sdk/data-available/stocks/government.md b/website/content/sdk/data-available/stocks/government.md index 1e265312635..383523fe6ee 100644 --- a/website/content/sdk/data-available/stocks/government.md +++ b/website/content/sdk/data-available/stocks/government.md @@ -1,10 +1,10 @@ --- title: Government -description: "The page provides comprehensive information about the Government module\u2014\ - that offers programmatic access to OpenBB Terminal functions. It includes details\ - \ about commands available, how to use them with Python, and examples. It serves\ - \ as a vital resource for those interested in examining US government data related\ - \ to publicly traded companies." +description: The page provides comprehensive information about the Government module + that offers programmatic access to OpenBB Terminal functions. It includes details + about commands available, how to use them with Python, and examples. It serves + as a vital resource for those interested in examining US government data related + to publicly traded companies. keywords: - Government module - programmatic access diff --git a/website/content/sdk/reference/crypto/defi/sreturn.md b/website/content/sdk/reference/crypto/defi/sreturn.md index 9ca0856f545..7542e193d30 100644 --- a/website/content/sdk/reference/crypto/defi/sreturn.md +++ b/website/content/sdk/reference/crypto/defi/sreturn.md @@ -1,6 +1,6 @@ --- title: sreturn -description: "Get terra blockchain staking returns history" +description: Get terra blockchain staking returns history keywords: - blockchain - terra diff --git a/website/content/sdk/reference/crypto/ov/platforms.md b/website/content/sdk/reference/crypto/ov/platforms.md index fac1a7f7345..ff4cc0b74eb 100644 --- a/website/content/sdk/reference/crypto/ov/platforms.md +++ b/website/content/sdk/reference/crypto/ov/platforms.md @@ -1,8 +1,8 @@ --- title: platforms -description: "This page contains a directory of all smart contract platforms such\ - \ as Ethereum, Solana, Cosmos, Polkadot, and Kusama. The page provides source codes\ - \ and instructs the use of functionalities in two formats \u2014 model and chart." +description: This page contains a directory of all smart contract platforms such + as Ethereum, Solana, Cosmos, Polkadot, and Kusama. The page provides source codes + and instructs the use of functionalities in two formats model and chart. keywords: - smart contract platforms - Ethereum diff --git a/website/content/sdk/reference/stocks/ca/balance.md b/website/content/sdk/reference/stocks/ca/balance.md index 6914fd10f67..7736c4910bd 100644 --- a/website/content/sdk/reference/stocks/ca/balance.md +++ b/website/content/sdk/reference/stocks/ca/balance.md @@ -1,8 +1,8 @@ --- title: balance -description: "This page provides a detailed view on the balance data obtained through\ - \ OpenBB Terminal\u2019s stocks comparison analysis. Python source code, parameters\ - \ for the function and return type are conventionally presented." +description: This page provides a detailed view on the balance data obtained through + OpenBB Terminal's stocks comparison analysis. Python source code, parameters + for the function and return type are conventionally presented. keywords: - balance data - stocks comparison analysis diff --git a/website/content/sdk/reference/stocks/fa/mktcap.md b/website/content/sdk/reference/stocks/fa/mktcap.md index 69589558b9c..e20c2e965d7 100644 --- a/website/content/sdk/reference/stocks/fa/mktcap.md +++ b/website/content/sdk/reference/stocks/fa/mktcap.md @@ -1,8 +1,8 @@ --- title: mktcap -description: "This page provides documentation about the mktcap function of OpenBB-finance\u2019\ - s Yahoo Finance Module. It explains the operation and usage of the functions for\ - \ market cap modeling and charting over a certain period." +description: This page provides documentation about the mktcap function of OpenBB-finance's + Yahoo Finance Module. It explains the operation and usage of the functions for + market cap modeling and charting over a certain period. keywords: - OpenBB-finance - Yahoo Finance diff --git a/website/content/terminal/reference/crypto/dd/gh.md b/website/content/terminal/reference/crypto/dd/gh.md index 37f3a21e515..adcf7cbef4e 100644 --- a/website/content/terminal/reference/crypto/dd/gh.md +++ b/website/content/terminal/reference/crypto/dd/gh.md @@ -1,9 +1,9 @@ --- title: gh -description: "Learn how to utilize the GH command line tool to track GitHub activity\ - \ for a given crypto coin. Discover how to filter by development activity, set frequency\ - \ intervals, and define start and end dates\u2014all with this powerful Python-based\ - \ tool." +description: Learn how to utilize the GH command line tool to track GitHub activity + for a given crypto coin. Discover how to filter by development activity, set frequency + intervals, and define start and end dates with this powerful Python-based + tool. keywords: - Github activity - Pull Request diff --git a/website/content/terminal/reference/stocks/disc/lowfloat.md b/website/content/terminal/reference/stocks/disc/lowfloat.md index 8954ed6b744..720be32884e 100644 --- a/website/content/terminal/reference/stocks/disc/lowfloat.md +++ b/website/content/terminal/reference/stocks/disc/lowfloat.md @@ -1,11 +1,11 @@ --- title: lowfloat -description: "The LowFloat webpage provides sophisticated tools for retrieving information\ - \ about top stocks with the lowest float. It offers a comprehensive database that\ - \ includes stocks from Nasdaq, the New York Stock Exchange, the American Stock Exchange,\ - \ and the Over the Counter Bulletin Board. The service not only provides a stock\u2019\ - s float, but also provides additional key data such as the number of outstanding\ - \ shares, short interest, and company industry." +description: The LowFloat webpage provides sophisticated tools for retrieving information + about top stocks with the lowest float. It offers a comprehensive database that + includes stocks from Nasdaq, the New York Stock Exchange, the American Stock Exchange, + and the Over the Counter Bulletin Board. The service not only provides a stock's + float, but also provides additional key data such as the number of outstanding + shares, short interest, and company industry. keywords: - lowfloat - stocks diff --git a/website/generate_platform_v4_markdown.py b/website/generate_platform_v4_markdown.py index c2bfb7be15f..fefb769efb2 100644 --- a/website/generate_platform_v4_markdown.py +++ b/website/generate_platform_v4_markdown.py @@ -490,15 +490,17 @@ def generate_platform_markdown() -> None: filepath = content_path / folder / f"{func_name}.md" markdown = generate_markdown(meta_command=meta_command) + if data_model := meta_command.get("model", None): + ## title is the desc here - clean this later ( data_model_card_title, data_model_card_description, ) = generate_data_model_card_info(meta_command) data_markdown = ( - f"---\ntitle: {data_model_card_title}\n" - "description: OpenBB Platform Data Model\n---\n\n" + f"---\ntitle: {data_model}\n" + f"description: {data_model_card_title}\n---\n\n" "\n\n" "import Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';\n\n" ) @@ -519,8 +521,8 @@ def generate_platform_markdown() -> None: data_reference_cards.setdefault(data_filepath.parent, []).append( dict( - title=data_model_card_title, - description=data_model_card_description or "", + title=data_model, + description=data_model_card_title or "", url=data_models_path.relative_to(data_models_path) / data_model, ) ) diff --git a/website/src/theme/Navbar/Logo/index.js b/website/src/theme/Navbar/Logo/index.js index 451f2d2cb66..5aebe6ba6d1 100644 --- a/website/src/theme/Navbar/Logo/index.js +++ b/website/src/theme/Navbar/Logo/index.js @@ -1,6 +1,7 @@ import Link from "@docusaurus/Link"; import { useLocation } from "@docusaurus/router"; import LetteringDocsLogo from "@site/src/components/Icons/LetteringDocsLogo"; +import clsx from "clsx"; import React from "react"; function getLogo(type) { @@ -10,9 +11,21 @@ function getLogo(type) { export default function NavbarLogo() { const { pathname } = useLocation(); const type = pathname.length > 1 ? pathname.split("/")[1] : "home"; + const [innerWidth, setInnerWidth] = React.useState(380); + + React.useEffect(() => { + if (typeof window !== 'undefined') { + window.addEventListener("resize", () => { + setInnerWidth(window.innerWidth); + + }); + } + } + , []); + return ( -
+
{getLogo(type)} diff --git a/website/src/theme/Root.tsx b/website/src/theme/Root.tsx index 87626fb3e2e..3da7e8aff94 100644 --- a/website/src/theme/Root.tsx +++ b/website/src/theme/Root.tsx @@ -12,8 +12,8 @@ export default function Root({ children }) { const [isIFrame, setIsIFrame] = useState(false); const [posthogLoaded, setPosthogLoaded] = useState(false); useEffect(() => { - setIsIFrame(window.self !== window.top); - if (window.self !== window.top) { + setIsIFrame(window?.self !== window?.top); + if (window?.self !== window?.top) { document.addEventListener("keydown", (e) => { if ((e.metaKey || e.ctrlKey) && e.key === "k") { e.preventDefault();