forked from fusedio/fused-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocusaurus.config.ts
More file actions
348 lines (317 loc) · 18.5 KB
/
docusaurus.config.ts
File metadata and controls
348 lines (317 loc) · 18.5 KB
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
const config: Config = {
title: "Fused",
tagline: "Code to map. Instantly.",
favicon: "img/favicon.png",
// Custom fields for version management
customFields: {
fusedPyVersion: '1.20.1',
},
trailingSlash: undefined,
// Production URL configuration
url: process.env.DEPLOYMENT_URL || "https://docs.fused.io",
baseUrl: process.env.BASE_URL || "/",
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "fusedio", // Usually your GitHub org/user name.
projectName: "fused-docs", // Usually your repo name.
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
// Mermaid diagrams
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
// Even if you don't use internationalization, 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"],
},
// Currently set to docs only mode. Change to enable blog and main site. https://docusaurus.io/docs/docs-introduction#docs-only-mode
presets: [
[
"classic",
{
docs: {
routeBasePath: "/",
editUrl: "https://github.com/fusedio/fused-docs/edit/main/",
sidebarPath: "./sidebars.ts",
breadcrumbs: false,
include: ["**/*.md", "**/*.mdx", "reference/fused/**"],
exclude: [
// '**/_*.{js,jsx,ts,tsx,md,mdx}',
// '**/_*/**',
// '**/*_unlisted/',
// '**/*_unlisted.mdx',
"**/*.test.{js,jsx,ts,tsx}",
"**/__tests__/**",
],
},
// blog: false,
blog: {
blogTitle: "Fused blog",
blogDescription: "Latest blog posts from Fused.",
postsPerPage: 999999,
blogSidebarTitle: "All posts",
blogSidebarCount: "ALL",
showReadingTime: true,
readingTime: ({ content, frontMatter, defaultReadingTime }) =>
defaultReadingTime({ content, options: { wordsPerMinute: 300 } }),
truncateMarker: /(<!--\s*truncate\s*-->)|({\/\*\s*truncate\s*\*\/})/,
// Ensure consistent canonical URLs
routeBasePath: "blog",
},
theme: {
customCss: "./src/css/custom.css",
},
} satisfies Preset.Options,
],
],
themeConfig: {
// Global site description for SEO
metadata: [
{
name: 'description',
content: 'Complete documentation for Fused: the Analytics platform where AI, real-time Python execution, and data work together. Build Analytics at the speed of thought',
},
],
tableOfContents: {
minHeadingLevel: 2,
maxHeadingLevel: 3,
},
algolia: {
appId: "JNTLW5AVDA",
apiKey: "b39072abe30fa571950e5c8449fa1552",
indexName: "fused",
contextualSearch: true,
// Optional: Algolia search parameters
searchParameters: {},
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: "search",
// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: true,
},
// Replace with your project's social card
// image: "https://fused-magic.s3.us-west-2.amazonaws.com/main_marketing_website/product_diagram_october2024_bg_small.png",
navbar: {
title: "Fused",
logo: {
alt: "Fused Logo",
src: "img/logo-black-bg-transparent.svg",
href: "/",
},
items: [
// 5 main sections
{
type: "docSidebar",
sidebarId: "guideSidebar",
position: "left",
label: "Guide",
},
{
type: "docSidebar",
sidebarId: "examplesSidebar",
position: "left",
label: "Examples",
},
{
type: "docSidebar",
sidebarId: "apiReferenceSidebar",
position: "left",
label: "API Reference",
},
{
type: "docSidebar",
sidebarId: "workbenchSidebar",
position: "left",
label: "Workbench Manual",
},
{ to: "/blog", label: "Blog", position: "left" },
{
href: "https://github.com/fusedio/udfs",
label: "GitHub",
position: "right",
},
{
href: "https://www.fused.io/workbench",
label: "Workbench",
position: "right",
},
{
href: "https://fused.instatus.com/",
label: "Status",
position: "right",
},
],
},
footer: {
// style: 'dark',
links: [
{
title: "Docs",
items: [
{
label: "Overview",
to: "/",
},
],
},
{
title: "Community",
items: [
{
label: "LinkedIn",
href: "https://www.linkedin.com/company/fusedio/",
},
{
label: "Discord",
href: "https://discord.com/invite/BxS5wMzdRk",
},
],
},
{
title: "More",
items: [
{
label: "Blog",
to: "https://www.fused.io/blog",
},
{
label: "GitHub",
href: "https://github.com/fusedio/udfs",
},
{
label: "YouTube",
href: "https://www.youtube.com/@FusedIO",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Fused, Inc. Built with Docusaurus.`,
},
theme: "@docusaurus/theme-nightOwl",
colorMode: {
defaultMode: "dark",
disableSwitch: true,
respectPrefersColorScheme: false,
},
prism: {
theme: prismThemes.oneDark,
darkTheme: prismThemes.oneDark,
additionalLanguages: ["python", "javascript", "bash", "json"],
},
// announcementBar: {
// id: "announcement",
// content:
// '⭐ Join the <a target="_blank" rel="noopener noreferrer" href="https://docs.google.com/forms/d/1NVzMjc2tXxlIgnFrxqQPM_NtG1B2AQ0En_pAbZHYSK0/edit">waitlist</a> for access to Fused Workbench! ⭐',
// backgroundColor: "#991199",
// textColor: "#ffffff",
// isCloseable: false,
// },
} satisfies Preset.ThemeConfig,
plugins: [
require.resolve("./docusaurus-plugin-custom-webpack"),
[
"@docusaurus/plugin-client-redirects",
{
redirects: [
// Revamped Jan 2026 Migration Redirects - Tutorials to new locations
{ to: "/examples/standalone-html-maps", from: ["/tutorials/Analytics%20&%20Dashboard/standalone-maps", "/tutorials/Analytics & Dashboard/standalone-maps", "/guide/working-with-udfs/building-outputs/standalone-maps", "/examples/building-outputs/standalone-maps"] },
{ to: "/examples/realtime-filtering-duckdb", from: ["/tutorials/Analytics%20&%20Dashboard/realtime-data-processing-with-duckdb-wasm", "/tutorials/Analytics & Dashboard/realtime-data-processing-with-duckdb-wasm", "/examples/realtime-processing"] },
{ to: "/examples/creating-charts", from: ["/tutorials/Analytics%20&%20Dashboard/interactive-graphs", "/tutorials/Analytics & Dashboard/interactive-graphs", "/guide/working-with-udfs/building-outputs/charts", "/examples/building-outputs/charts", "/examples/interactive-charts", "/examples/vibe-chart-building"] },
{ to: "/guide/data-input-outputs/import-connection/ai-data-connection", from: ["/tutorials/Analytics%20&%20Dashboard/let-anyone-talk-to-your-data", "/tutorials/Analytics & Dashboard/let-anyone-talk-to-your-data", "/guide/data-input-outputs/export-api/mcp-servers"] },
{ to: "/examples/creating-charts", from: ["/tutorials/Analytics%20&%20Dashboard/stack-overflow-surveys", "/tutorials/Analytics & Dashboard/stack-overflow-surveys"] },
{ to: "/examples/currency-prediction", from: ["/tutorials/Analytics%20&%20Dashboard/currency-trading", "/tutorials/Analytics & Dashboard/currency-trading"] },
// Data Science & AI tutorials
{ to: "/examples/zonal-stats", from: ["/tutorials/Data%20Science%20&%20AI/discover_data", "/tutorials/Data Science & AI/discover_data", "/examples/data-exploration"] },
{ to: "/examples/web-scraping", from: ["/tutorials/Data%20Science%20&%20AI/scraping", "/tutorials/Data Science & AI/scraping"] },
{ to: "/examples/pdf-scraping", from: ["/tutorials/Data%20Science%20&%20AI/pdf_scraping", "/tutorials/Data Science & AI/pdf_scraping"] },
{ to: "/examples/site-selection-analysis", from: ["/tutorials/Data%20Science%20&%20AI/competitor_analysis", "/tutorials/Data Science & AI/competitor_analysis", "/examples/competitor-analysis"] },
// Engineering & ETL tutorials
{ to: "/guide/data-input-outputs/import-connection/cloud-storage", from: ["/tutorials/Engineering%20&%20ETL/connect-your-data-to-fused", "/tutorials/Engineering & ETL/connect-your-data-to-fused"] },
{ to: "/guide/data-input-outputs/import-connection/cloud-storage", from: ["/tutorials/Engineering%20&%20ETL/handling-large-remote-files", "/tutorials/Engineering & ETL/handling-large-remote-files"] },
{ to: "/guide/data-input-outputs/export-api/tokens-endpoints", from: ["/tutorials/Engineering%20&%20ETL/turn-your-data-into-an-api", "/tutorials/Engineering & ETL/turn-your-data-into-an-api"] },
// Geospatial tutorials - H3
{ to: "/guide/h3-analytics/aggregations", from: ["/tutorials/Geospatial%20with%20Fused/h3-tiling", "/tutorials/Geospatial with Fused/h3-tiling"] },
{ to: "/guide/h3-analytics/aggregations", from: ["/tutorials/Geospatial%20with%20Fused/h3-tiling/when-to-use-h3", "/tutorials/Geospatial with Fused/h3-tiling/when-to-use-h3"] },
{ to: "/guide/h3-analytics/converting", from: ["/tutorials/Geospatial%20with%20Fused/h3-tiling/file-to-h3", "/tutorials/Geospatial with Fused/h3-tiling/file-to-h3"] },
{ to: "/guide/h3-analytics/converting", from: ["/tutorials/Geospatial%20with%20Fused/h3-tiling/dynamic-tile-to-h3", "/tutorials/Geospatial with Fused/h3-tiling/dynamic-tile-to-h3"] },
{ to: "/guide/h3-analytics/converting", from: ["/tutorials/Geospatial%20with%20Fused/h3-tiling/ingesting-dataset-to-h3", "/tutorials/Geospatial with Fused/h3-tiling/ingesting-dataset-to-h3"] },
{ to: "/guide/h3-analytics/aggregations", from: ["/tutorials/Geospatial%20with%20Fused/h3-tiling/analysis-with-h3/aggregating-h3-data", "/tutorials/Geospatial with Fused/h3-tiling/analysis-with-h3/aggregating-h3-data"] },
{ to: "/guide/h3-analytics/joining", from: ["/tutorials/Geospatial%20with%20Fused/h3-tiling/analysis-with-h3/joining-h3-data", "/tutorials/Geospatial with Fused/h3-tiling/analysis-with-h3/joining-h3-data"] },
{ to: "/examples/zonal-stats", from: ["/tutorials/Geospatial%20with%20Fused/h3-tiling/analysis-with-h3/zonal-statistics", "/tutorials/Geospatial with Fused/h3-tiling/analysis-with-h3/zonal-statistics"] },
// Geospatial tutorials - Read/Write/Ingestion
{ to: "/guide/data-input-outputs/read-write/geospatial/geospatial-reading", from: ["/tutorials/Geospatial%20with%20Fused/read-data", "/tutorials/Geospatial with Fused/read-data"] },
{ to: "/guide/data-input-outputs/read-write/geospatial/geospatial-writing", from: ["/tutorials/Geospatial%20with%20Fused/write-data", "/tutorials/Geospatial with Fused/write-data"] },
{ to: "/guide/data-input-outputs/read-write/geospatial/ingestion", from: ["/tutorials/Geospatial%20with%20Fused/geospatial-data-ingestion", "/tutorials/Geospatial with Fused/geospatial-data-ingestion"] },
{ to: "/guide/data-input-outputs/read-write/geospatial/ingestion", from: ["/tutorials/Geospatial%20with%20Fused/geospatial-data-ingestion/why-ingestion", "/tutorials/Geospatial with Fused/geospatial-data-ingestion/why-ingestion"] },
{ to: "/guide/data-input-outputs/read-write/geospatial/ingestion", from: ["/tutorials/Geospatial%20with%20Fused/geospatial-data-ingestion/ingest-your-data", "/tutorials/Geospatial with Fused/geospatial-data-ingestion/ingest-your-data"] },
{ to: "/guide/data-input-outputs/read-write/geospatial/ingestion", from: ["/tutorials/Geospatial%20with%20Fused/geospatial-data-ingestion/geospatial-file-formats", "/tutorials/Geospatial with Fused/geospatial-data-ingestion/geospatial-file-formats"] },
// Geospatial tutorials - Other
{ to: "/guide/working-with-udfs/udf-best-practices/geospatial-single-vs-tile", from: ["/tutorials/Geospatial%20with%20Fused/filetile", "/tutorials/Geospatial with Fused/filetile", "/guide/working-with-udfs/geospatial/single-vs-tile"] },
{ to: "/guide/data-input-outputs/export-api/geospatial-export", from: ["/tutorials/Geospatial%20with%20Fused/other-integrations", "/tutorials/Geospatial with Fused/other-integrations"] },
{ to: "/guide/data-input-outputs/import-connection/geospatial/gee", from: ["/tutorials/Geospatial%20with%20Fused/gee_bigquery", "/tutorials/Geospatial with Fused/gee_bigquery"] },
{ to: "/examples/canvas-gallery", from: ["/tutorials/Geospatial%20with%20Fused/canvas-catalog", "/tutorials/Geospatial with Fused/canvas-catalog", "/examples/canvas-examples"] },
// Geospatial use cases
{ to: "/examples/ais-dark-vessels", from: ["/tutorials/Geospatial%20with%20Fused/use-cases/dark-vessel-detection", "/tutorials/Geospatial with Fused/use-cases/dark-vessel-detection", "/examples/dark-vessel-detection"] },
{ to: "/examples/climate-dashboard", from: ["/tutorials/Geospatial%20with%20Fused/use-cases/Climate%20Dashboard", "/tutorials/Geospatial with Fused/use-cases/Climate Dashboard"] },
{ to: "/examples/maxar-satellite-imagery", from: ["/tutorials/Geospatial%20with%20Fused/use-cases/exploring_maxar_data", "/tutorials/Geospatial with Fused/use-cases/exploring_maxar_data", "/examples/satellite-imagery"] },
{ to: "/examples/zonal-stats", from: ["/tutorials/Geospatial%20with%20Fused/use-cases/zonal-stats", "/tutorials/Geospatial with Fused/use-cases/zonal-stats"] },
{ to: "/examples/creating-charts", from: ["/tutorials/Geospatial%20with%20Fused/use-cases/vibe-coded-timeseries", "/tutorials/Geospatial with Fused/use-cases/vibe-coded-timeseries"] },
// 2min with Fused / Quickstart
{ to: "/guide/getting-started/first-udf-basics", from: ["/tutorials/2min-with-fused", "/quickstart"] },
{ to: "/guide/getting-started/first-udf-basics", from: ["/tutorials/load-and-export-data", "/tutorials/load_and_save_data"] },
// Core concepts redirects
{ to: "/guide/working-with-udfs/udf-best-practices/realtime", from: ["/core-concepts/run-udfs/run-small-udfs", "/core-concepts/run-udfs", "/core-concepts/async", "/guide/working-with-udfs/execution/realtime", "/guide/getting-started/udf-best-practices/realtime"] },
{ to: "/guide/working-with-udfs/udf-best-practices/scaling-out", from: ["/core-concepts/run-udfs/run_large", "/core-concepts/run-udfs/run-large", "/guide/working-with-udfs/execution/batch-jobs", "/guide/getting-started/udf-best-practices/batch-jobs", "/guide/working-with-udfs/udf-best-practices/batch-jobs", "/guide/working-with-udfs/execution/parallel", "/guide/getting-started/udf-best-practices/parallel", "/guide/working-with-udfs/udf-best-practices/parallel"] },
{ to: "/guide/working-with-udfs/writing-udfs", from: ["/core-concepts/write", "/core-concepts/best-practices/udf-best-practices"] },
{ to: "/guide/working-with-udfs/udf-best-practices/caching", from: ["/core-concepts/cache", "/guide/working-with-udfs/caching"] },
{ to: "/guide/working-with-udfs/udf-best-practices/storage", from: ["/core-concepts/content-management/file-system", "/guide/advanced-setup/file-system"] },
{ to: "/guide/advanced-setup/git-integration", from: ["/core-concepts/content-management/git"] },
{ to: "/guide/advanced-setup/dependencies", from: ["/core-concepts/run-udfs/dependencies"] },
{ to: "/guide/getting-started/workbench-intro", from: ["/core-concepts/best-practices/workbench-best-practices"] },
{ to: "/guide/getting-started/first-udf-basics", from: ["/core-concepts/why"] },
// Old workbench paths
{ to: "/workbench/udf-explorer", from: ["/workbench/udf-catalog"] },
{ to: "/workbench/udf-builder/code-editor", from: ["/workbench/udf-editor"] },
// Jan 2026 docs migration redirects
{ to: "/guide/working-with-udfs/run-udfs-as-api", from: ["/guide/data-input-outputs/export-api/dynamic-file-api", "/guide/working-with-udfs/calling-udfs-as-api"] },
{ to: "/guide/working-with-udfs/fused-run", from: ["/guide/working-with-udfs/run-udfs-in-python"] },
{ to: "/guide/working-with-udfs/fused-submit", from: ["/guide/working-with-udfs/run-udfs-in-parallel"] },
{ to: "/examples/sharing-canvas-dashboards", from: ["/guide/working-with-udfs/building-outputs/dashboards", "/examples/building-outputs/dashboards"] },
{ to: "/guide/working-with-udfs/udf-best-practices/geospatial-single-vs-tile", from: ["/guide/working-with-udfs/udf-best-practices/geospatial/single-vs-tile"] },
// API Reference flattening redirects
{ to: "/python-sdk/overview", from: ["/python-sdk/top-level-functions"] },
{ to: "/guide/advanced-setup/local-installation", from: ["/python-sdk/index", "/python-sdk/authentication"] },
{ to: "/python-sdk/overview", from: ["/python-sdk"] },
],
// createRedirects(existingPath) {
// if (existingPath.includes("/user-guide/out")) {
// return [existingPath.replace("/user-guide/out", "/basics/out")];
// }
// if (existingPath.includes("/basics/user-guide/")) {
// return [
// existingPath.replace("/user-guide/", "/basics/user-guide/"),
// ];
// }
// return undefined;
// },
},
],
// Only load Google Analytics in production
...(process.env.NODE_ENV === 'production' ? [
[
"@docusaurus/plugin-google-gtag",
{
trackingID: "G-CRPW2C404Y",
anonymizeIP: true,
},
],
] : []),
],
};
export default config;