1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
// @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/usage/intros/forecasting",
to: "/terminal/usage/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,
},
// TODO - Jose can you make this so we get lighter color on main view - like bot docs
colorMode: {
defaultMode: "dark",
disableSwitch: false,
respectPrefersColorScheme: false,
},
algolia: {
appId: "7D1HQ0IXAS",
apiKey: "a2e289977b4b663ed9cf3d4635a438fd",
indexName: "openbbterminal",
contextualSearch: false,
},
}),
};
module.exports = config;
|
