Files
OpenBB/website/docusaurus.config.js
jose-donato 6e9fefce9e Adds bot documentation to docusaurus and changes for hub (#4409)
* feat: adds bot docs to docu

* fix: file structure

* fix: brings changelog and switch platform button

* adding available options and changing Example text

* fix: detect whether iframe, fix availableoptions component, dynamic update third friday for options component

* fix: updated readme to reflect new changes

* fix: made it so from iframe only shows relevant sidebar

* PLAY BUTTON WOOO - works on discord/charting/chart

* comment

* fix: search bar, improve search

* fix: hijacks ctrl+k from iframe, adds visit to hub link

* about

* setting up play button for all images on Discord

* Bot docs updates

* terminal/faqs

* update main page

* add changelog to terminal

* SDK refactoring

* minor reordering

* bot struct in place

* move bot faqs over

* updating bot index and installation

* add new letterings

* fix: adds new navbar

* fix: new bot images and layouts

* updating installation and flow

* black linter

* spelling

* spelling

* The best commit

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-03-16 16:29:57 +00:00

119 lines
3.2 KiB
JavaScript
Vendored

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require("prism-react-renderer/themes/vsLight");
const darkCodeTheme = require("prism-react-renderer/themes/vsDark");
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "OpenBB Docs",
tagline: "OpenBB Docs",
url: "https://docs.openbb.co", // Your website URL
baseUrl: "/",
projectName: "OpenBBTerminal",
organizationName: "OpenBB-finance",
trailingSlash: false,
onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon.ico",
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "en",
locales: ["en"],
},
plugins: [
[
"@docusaurus/plugin-client-redirects",
{
redirects: [
{
from: "/terminal/guides/intros/forecasting",
to: "/terminal/guides/intros/forecast",
},
],
},
],
async function twPlugin(context, options) {
return {
name: "docusaurus-tailwindcss",
configurePostCss(postcssOptions) {
// Appends TailwindCSS and AutoPrefixer.
postcssOptions.plugins.push(require("tailwindcss"));
postcssOptions.plugins.push(require("autoprefixer"));
return postcssOptions;
},
};
},
/*[
"@docusaurus/plugin-content-docs",
{
id: "sdk",
path: "content/sdk",
routeBasePath: "sdk",
editUrl:
"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/",
sidebarPath: require.resolve("./sidebars.js"),
},
],
[
"@docusaurus/plugin-content-docs",
{
id: "bot",
path: "content/bot",
routeBasePath: "bot",
editUrl:
"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/",
sidebarPath: require.resolve("./sidebars.js"),
},
],*/
],
presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve("./sidebars.js"),
editUrl:
"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/",
routeBasePath: "/",
path: "content",
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
image: "img/banner.png",
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
colorMode: {
defaultMode: "dark",
disableSwitch: false,
respectPrefersColorScheme: false,
},
algolia: {
appId: "7D1HQ0IXAS",
apiKey: "a2e289977b4b663ed9cf3d4635a438fd",
indexName: "openbbterminal",
contextualSearch: false,
},
}),
};
module.exports = config;