docusaurus.config.ts

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

import fs from "fs";
import path from "path";
import type { Options, ThemeConfig } from "@docusaurus/preset-classic";
import type { Config } from "@docusaurus/types";
import autoprefixer from "autoprefixer";
import { themes } from "prism-react-renderer";
import katex from "rehype-katex";
import math from "remark-math";
import tailwind from "tailwindcss";

export default {
	title: "OpenBB Docs",
	tagline: "OpenBB Docs",
	url: "https://docs.openbb.co", // Your website URL
	baseUrl: "/",
	projectName: "OpenBB",
	organizationName: "OpenBB-finance",
	trailingSlash: false,
	onBrokenLinks: "warn",
	onBrokenAnchors: "warn",
	"markdown": {
		"hooks": {
			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: "/pro/",
						to: "/workspace/developers/data-integration",
					},
					{
						from: "/pro/enterprise",
						to: "/workspace/getting-started/enterprise",
					},
					{
						from: "/pro/openbb-copilot",
						to: "/workspace/analysts/ai-features/copilot-basics",
					},
					{
						from: "/pro/platform-installer",
						to: "/workspace/getting-started/platform-installer",
					},
					{
						from: "/workspace/data-connector",
						to: "/workspace/developers/data-integration",
					},
					{
						from: "/workspace/developers/agent-skills",
						to: "/agents/app-builder-resources",
					},
					{
						from: "/agents/building-an-app",
						to: "/agents/app-builder-resources",
					},
					{
						from: "/agents/app-building-skill",
						to: "/agents/app-builder-resources",
					},
					{
						from: "/excel/enterprise",
						to: "https://openbb.co/pricing",
					},
					{
						from: "/bot",
						to: "https://openbb.co/blog/we-are-handing-over-the-openbb-bot-to-focus-on-our-mission",
					},
					// Add redirects for old excel paths
					{
						from: "/excel",
						to: "/workspace/analysts/excel-addin/excel-overview",
					},
					// Add redirects for old getting-started paths  
					{
						from: "/getting-started/enterprise",
						to: "/workspace/getting-started/enterprise",
					},
					{
						from: "/getting-started/excel-installation",
						to: "/workspace/analysts/excel-addin/excel-installation",
					},
					{
						from: "/getting-started/faqs",
						to: "/workspace/getting-started/faqs",
					},
					// Redirects for old ODP paths
					{
						from: "/platform",
						to: "/odp/python",
					},
					{
						from: "/desktop",
						to: "/odp/desktop",
					},
					{
						from: "/python",
						to: "/odp/python",
					},
					{
						from: "/cli",
						to: "/odp/cli",
					},
				],
				createRedirects: (existingPath) => {
					// Redirect old paths to new /odp/* structure
					if (existingPath.startsWith("/odp/desktop/")) {
						return existingPath.replace("/odp/desktop/", "/desktop/");
					}
					if (existingPath.startsWith("/odp/python/")) {
						return [
							existingPath.replace("/odp/python/", "/python/"),
							existingPath.replace("/odp/python/", "/platform/"),
						];
					}
					if (existingPath.startsWith("/odp/cli/")) {
						return existingPath.replace("/odp/cli/", "/cli/");
					}
					if (existingPath.startsWith("/pro/")) {
						const newPath = existingPath.replace("/pro/", "/workspace/developers/");
						if (newPath.includes("data-connector")) {
							return newPath.replace("/data-connector/", "/data-integration/");
						}
						return newPath;
					}
					if (existingPath.includes("data-connector")) {
						return existingPath.replace(
							"/data-connector/",
							"/data-integration/",
						);
					}
					return undefined;
				},
			},
		],
		async function twPlugin(context, options) {
			return {
				name: "docusaurus-tailwindcss",
				configurePostCss(postcssOptions) {
					// Appends TailwindCSS and AutoPrefixer.
					postcssOptions.plugins.push(tailwind);
					postcssOptions.plugins.push(autoprefixer);
					return postcssOptions;
				},
			};
		},
		async function sidebarExportPlugin(context) {
			return {
				name: "sidebar-export-plugin",
				async contentLoaded({ content, actions }) {
					// This runs after docs plugin processes content
				},
				async allContentLoaded({ allContent, actions }) {
					const { setGlobalData, createData } = actions;
					const docsContent = allContent["docusaurus-plugin-content-docs"]?.default;
					const loadedVersion = docsContent?.loadedVersions?.[0];

					if (loadedVersion?.sidebars?.tutorialSidebar) {
						// Get the docs metadata to resolve labels
						const docsMetadata = loadedVersion.docs;

						// Recursively resolve labels for sidebar items
						const resolveLabels = (items: any[]): any[] => {
							return items.map(item => {
								if (item.type === "doc") {
									const doc = docsMetadata.find((d: any) => d.id === item.id);
									return {
										...item,
										label: item.label || doc?.title || doc?.id?.split("/").pop(),
										href: doc?.permalink,
									};
								}
								if (item.type === "category") {
									let categoryHref = null;
									if (item.link?.type === "doc" && item.link?.id) {
										const linkDoc = docsMetadata.find((d: any) => d.id === item.link.id);
										categoryHref = linkDoc?.permalink;
									}
									return {
										...item,
										href: categoryHref,
										items: item.items ? resolveLabels(item.items) : [],
									};
								}
								return item;
							});
						};

						const resolvedSidebar = resolveLabels(loadedVersion.sidebars.tutorialSidebar);
						setGlobalData({ sidebar: resolvedSidebar });
					}
				},
			};
		},
		async function pluginLlmsTxt(context) {
			return {
				name: "llms-txt-plugin",
				loadContent: async () => {
					const { siteDir } = context;
					const contentDir = path.join(siteDir, "content");
					// ODP has sub-sections that each get their own llms.txt
					const sectionContent: Record<string, string[]> = {
						agents: [],
						workspace: [],
						"odp/desktop": [],
						"odp/python": [],
						"odp/cli": [],
						snowflake: [],
					};

					// recursive function to get all mdx files
					const getMdxFiles = async (dir: string) => {
						const entries = await fs.promises.readdir(dir, {
							withFileTypes: true,
						});

						for (const entry of entries) {
							const fullPath = path.join(dir, entry.name);
							if (entry.isDirectory()) {
								await getMdxFiles(fullPath);
							} else if (
								entry.name.endsWith(".mdx") ||
								entry.name.endsWith(".md")
							) {
								try {
									const content = await fs.promises.readFile(fullPath, "utf8");
									// Determine which section this file belongs to
									const relativePath = path.relative(contentDir, fullPath);
									const pathParts = relativePath.split(path.sep);
									
									// Check for ODP sub-sections first (odp/desktop, odp/python, odp/cli)
									if (pathParts[0] === "odp" && pathParts.length > 1) {
										const subSection = `odp/${pathParts[1]}`;
										if (subSection in sectionContent) {
											sectionContent[subSection].push(content);
										}
									} else if (pathParts[0] in sectionContent) {
										sectionContent[pathParts[0]].push(content);
									}
								} catch (err) {
									console.error(`Error processing file ${fullPath}:`, err);
								}
							}
						}
					};

					await getMdxFiles(contentDir);

					// Log content sizes for each section
					for (const [section, content] of Object.entries(sectionContent)) {
						const totalSize = content.reduce(
							(acc, curr) => acc + curr.length,
							0,
						);
						console.log(
							`Section ${section} has ${content.length} files with total size of ${(totalSize / 1024 / 1024).toFixed(2)}MB`,
						);
					}

					return { sectionContent };
				},
				postBuild: async ({ content, routes, outDir }) => {
					const { sectionContent } = content as {
						sectionContent: Record<string, string[]>;
					};
					const { siteDir } = context;
					const staticDir = path.join(siteDir, "static");

					// Find docs plugin route config
					const docsPluginRouteConfig = routes.filter(
						(route) => route.plugin.name === "docusaurus-plugin-content-docs",
					)[0];

					const allDocsRouteConfig = docsPluginRouteConfig.routes?.filter(
						(route) => route.path === "/",
					)[0];

					if (!allDocsRouteConfig?.props?.version) {
						return;
					}

					const currentVersionDocsRoutes = (
						allDocsRouteConfig.props.version as Record<string, unknown>
					).docs as Record<string, Record<string, unknown>>;

					// Group routes by section
					// ODP has sub-sections that each get their own llms.txt
					const sectionRoutes: Record<string, string[]> = {
						agents: [],
						workspace: [],
						"odp/desktop": [],
						"odp/python": [],
						"odp/cli": [],
						snowflake: [],
					};

					for (const [docPath, record] of Object.entries(
						currentVersionDocsRoutes,
					)) {
						const pathParts = docPath.split("/");
						
						// Check for ODP sub-sections first (odp/desktop, odp/python, odp/cli)
						if (pathParts[0] === "odp" && pathParts.length > 1) {
							const subSection = `odp/${pathParts[1]}`;
							if (subSection in sectionRoutes) {
								const fullUrl = `${context.siteConfig.url}/${docPath}`;
								sectionRoutes[subSection].push(
									`- [${record.title}](${fullUrl}): ${record.description}`,
								);
							}
						} else if (pathParts[0] in sectionRoutes) {
							const fullUrl = `${context.siteConfig.url}/${docPath}`;
							sectionRoutes[pathParts[0]].push(
								`- [${record.title}](${fullUrl}): ${record.description}`,
							);
						}
					}

					// Process each section
					for (const [section, routes] of Object.entries(sectionRoutes)) {
						try {
							// Create directory in static folder
							const sectionDir = path.join(staticDir, section);
							await fs.promises.mkdir(sectionDir, { recursive: true });

							// Write section-specific llms.txt
							const llmsTxt = `# ${context.siteConfig.title} - ${section}\n\n## Docs\n\n${routes.join("\n")}`;
							await fs.promises.writeFile(
								path.join(sectionDir, "llms.txt"),
								llmsTxt,
							);

							// Also write to build output directory for direct access
							const buildSectionDir = path.join(outDir, section);
							await fs.promises.mkdir(buildSectionDir, { recursive: true });
							await fs.promises.writeFile(
								path.join(buildSectionDir, "llms.txt"),
								llmsTxt,
							);

							// Write section-specific llms-full.txt
							const sectionFullContent =
								sectionContent[section].join("\n\n---\n\n");

							await fs.promises.writeFile(
								path.join(sectionDir, "llms-full.txt"),
								sectionFullContent,
							);

							// Also write to build output directory for direct access
							await fs.promises.writeFile(
								path.join(buildSectionDir, "llms-full.txt"),
								sectionFullContent,
							);
						} catch (err) {
							console.error(`Error processing section ${section}:`, err);
						}
					}
				},
			};
		},
	],
	presets: [
		[
			"classic",
			{
				docs: {
					sidebarPath: "./sidebars.js",
					editUrl: "https://github.com/OpenBB-finance/openbb-docs/edit/main/",
					showLastUpdateTime: true,
					showLastUpdateAuthor: true,
					routeBasePath: "/",
					path: "content",
					remarkPlugins: [math],
					rehypePlugins: [katex],
				},
				theme: {
					customCss: "./src/css/custom.css",
				},
			} satisfies Options,
		],
	],
	headTags: [
		{
			tagName: "meta",
			attributes: {
				"http-equiv": "Content-Security-Policy",
				content:
					"object-src 'self'; img-src * blob: data:; connect-src *; script-src 'self' 'unsafe-eval' 'unsafe-inline'; frame-ancestors 'self' 'https://pro.openbb.co' 'https://openbb.co' 'https://my.openbb.co'",
			},
		},
		{
			tagName: "meta",
			attributes: {
				"http-equiv": "Cache-Control",
				content: "max-age=3600, must-revalidate",
			},
		},
		{
			tagName: "meta",
			attributes: {
				"http-equiv": "X-Content-Type-Options",
				content: "nosniff",
			},
		},
	],
	themeConfig: {
		image: "img/banner.png",
		docs: {
			sidebar: {
				autoCollapseCategories: true,
			},
		},
		prism: {
			theme: themes.vsLight,
			darkTheme: themes.vsDark,
			additionalLanguages: ["json"],
		},
		// csp: {
		// 	"default-src": ["'self'"],
		// 	"script-src": ["self"],
		// 	"style-src": ["'self'"],
		// 	"img-src": ["*", "data:", "blob:"],
		// 	"connect-src": ["*"],
		// 	"frame-ancestors": [
		// 		"'self'",
		// 		"https://pro.openbb.co",
		// 		"https://openbb.co",
		// 		"https://my.openbb.co",
		// 	],
		// },
		// 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", // pragma: allowlist secret
			indexName: "openbbterminal",
			contextualSearch: false,
		},
	} satisfies ThemeConfig,
	stylesheets: [
		{
			href: "/katex/katex.min.css",
			type: "text/css",
		},
	],
} satisfies Config;