diff --git a/.gitignore b/.gitignore index 6deb07cb823..fa4ee80a6fa 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ logs/ .DS_Store *.env .venv +venv .vscode *.ipynb env/ diff --git a/website/README.md b/website/README.md index fffe137ec2c..1ab77d9fdbb 100644 --- a/website/README.md +++ b/website/README.md @@ -1,3 +1,70 @@ +# OpenBB Documentation Website + +This repository contains the source code for the OpenBB Documentation Website. + +The website was built using [Docusaurus](https://docusaurus.io/), a modern static website generator and [TailwindCSS](https://tailwindcss.com) as styling solution. +The final website can be found at [https://docs.openbb.co](https://docs.openbb.co). + + +## Folder Structure + +```bash +website +├── content # Markdown files +| ├── sdk # SDK markdown files +| └── terminal # Terminal markdown files +├── old_content # previous terminal documentation; required to get the examples for terminal reference +├── src # react stuff for website +├── static # Static files +├── generate_sdk_markdown.py # Script to generate markdown files for SDK +└── generate_terminal_markdown.py # Script to generate markdown files for Terminal +``` + +### Markdown files + +The markdown files are used to generate the website. The markdown files are located in the `content` folder. The markdown files are generated using the `generate_sdk_markdown.py` and `generate_terminal_markdown.py` scripts. The markdown files are generated from the docstrings in the SDK and Terminal code. Files inside `content/sdk/reference` and `content/terminal/reference` should not be changed manually because they are generated automatically on every commit. + + +## Run locally + +### Prerequisites + +- [Node.js](https://nodejs.org/en/) >= 16.13.0 +To check if you have Node.js installed, run this command in your terminal: + +```bash +node --version # should be v16.13.0 or higher +``` + +### Install dependencies + +```bash +npm install +``` + +### Start development server + +```bash +npm start +``` + +This command starts a local development server and open up a browser window in `http://localhost:3000`. Most changes are reflected live without having to restart the server. + +### Build + +```bash +npm run build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. We use Github Pages to host our website. It's deployed in the `gh-pages` branch. + + + +## Contributing + +We welcome contributions to the OpenBB Documentation Website. + +---
DEPRECATED - OLD README

diff --git a/website/content/sdk/guides/intros/forecast.md b/website/content/sdk/guides/intros/forecast.md index 44272582720..83636c16d7d 100644 --- a/website/content/sdk/guides/intros/forecast.md +++ b/website/content/sdk/guides/intros/forecast.md @@ -76,7 +76,7 @@ aapl = openbb.stocks.load("aapl") combined_df = openbb.forecast.combine(spy,aapl, dataset="aapl", column= "Close") openbb.forecast.show(combined_df) ``` -image +image ![Combine View](https://user-images.githubusercontent.com/105685594/203791078-181431cb-99bf-4d26-bfff-b4cf34b5dee2.png) @@ -113,7 +113,6 @@ openbb.forecast.expo_chart(df) ``` ​ Here was can now see a chart and table with the expected values, and historic data. The chart also tells us how our backtesing performed, so that we can know the accuracy of our prediction. -​ -![Expo View](https://user-images.githubusercontent.com/72827203/202429347-b3ab488d-d4f6-42bb-80d1-c66b3c5a92df.png) -​ + +![Expo View](https://user-images.githubusercontent.com/72827203/202429347-b3ab488d-d4f6-42bb-80d1-c66b3c5a92df.png) \ No newline at end of file diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index caa1e0c0580..a313a2e440b 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -25,12 +25,10 @@ export default function Home(): JSX.Element {

OpenBB Terminal @@ -50,12 +48,10 @@ export default function Home(): JSX.Element {

OpenBB SDK diff --git a/website/src/theme/Footer/index.js b/website/src/theme/Footer/index.js index 68e894f525e..748141c3727 100644 --- a/website/src/theme/Footer/index.js +++ b/website/src/theme/Footer/index.js @@ -1,16 +1,10 @@ import React, { useEffect, useState } from "react"; -import { useThemeConfig } from "@docusaurus/theme-common"; -import FooterLinks from "@theme/Footer/Links"; -import FooterLogo from "@theme/Footer/Logo"; -import FooterCopyright from "@theme/Footer/Copyright"; -import FooterLayout from "@theme/Footer/Layout"; import Link from "@docusaurus/Link"; import LetteringLogo from "@site/src/components/Icons/LetteringLogo"; import StarIcon from "@site/src/components/Icons/Star"; import GithubIcon from "@site/src/components/Icons/Github"; import LinkedinIcon from "@site/src/components/Icons/Linkedin"; import TwitterIcon from "@site/src/components/Icons/Twitter"; -import InstagramIcon from "@site/src/components/Icons/Instagram"; import TiktokIcon from "@site/src/components/Icons/Tiktok"; import RedditIcon from "@site/src/components/Icons/Reddit"; import DiscordIcon from "@site/src/components/Icons/Discord"; @@ -135,7 +129,7 @@ function Footer() {