Repository navigation
Expand file tree
/
Copy pathdocusaurus.config.js
More file actions
814 lines (787 loc) · 35.6 KB
/
Copy pathdocusaurus.config.js
File metadata and controls
814 lines (787 loc) · 35.6 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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
// @ts-nocheck
// Note: type annotations allow type checking and IDEs autocompletion
const awsSvg =
`<svg preserveAspectRatio="none" width="30" height="20" viewBox="14.7 23 42 26.2" xmlns="http://www.w3.org/2000/svg"><polygon points="27.09 35.764 25.984 40.34 28.182 40.34 27.115 35.764" fill="#F7981F"/><path d="m16.302 40.744v0.666c0 3.311 3.579 6.66 7.991 6.66h23.533c4.412 0 7.991-3.35 7.991-6.66v-0.666c0-3.078-3.098-6.943-7.081-7.283-0.089-2.752-2.342-4.955-5.113-4.955-1.076 0-2.074 0.334-2.898 0.9-1.58-3.52-5.107-5.977-9.216-5.977-5.579 0-10.101 4.521-10.101 10.102 0 0.1 0.012 0.195 0.015 0.293-2.993 0.867-5.121 4.371-5.121 6.92zm12.699 3.055l-0.572-2.275h-2.717l-0.599 2.275h-1.547l2.639-9.283h1.898l2.444 9.283h-1.546zm9.012 0h-1.716l-1.196-6.994h-0.026l-1.183 6.994h-1.716l-1.795-9.283h1.496l1.221 7.215h0.027l1.221-7.215h1.561l1.248 7.254h0.026l1.209-7.254h1.469l-1.846 9.283zm5.433 0.181c-2.301 0-2.821-1.533-2.821-2.834v-0.221h1.482v0.234c0 1.131 0.494 1.703 1.521 1.703 0.936 0 1.403-0.664 1.403-1.354 0-0.975-0.493-1.404-1.325-1.65l-1.015-0.352c-1.353-0.52-1.937-1.221-1.937-2.547 0-1.691 1.144-2.627 2.886-2.627 2.379 0 2.626 1.482 2.626 2.443v0.209h-1.482v-0.195c0-0.846-0.377-1.34-1.3-1.34-0.637 0-1.248 0.352-1.248 1.34 0 0.793 0.403 1.195 1.392 1.572l1 0.365c1.313 0.467 1.886 1.184 1.886 2.457 1e-3 1.979-1.196 2.797-3.068 2.797z" fill="#F7981F"/><path d="m26.205 34.516l-2.639 9.283h1.547l0.599-2.275h2.717l0.572 2.275h1.547l-2.444-9.283h-1.899zm-0.221 5.824l1.105-4.576h0.025l1.066 4.576h-2.196z" fill="#fff"/><polygon points="37.181 41.77 37.154 41.77 35.906 34.516 34.346 34.516 33.125 41.73 33.098 41.73 31.877 34.516 30.381 34.516 32.176 43.799 33.892 43.799 35.074 36.805 35.101 36.805 36.297 43.799 38.013 43.799 39.858 34.516 38.39 34.516" fill="#fff"/><path d="m44.629 38.729l-1-0.365c-0.988-0.377-1.392-0.779-1.392-1.572 0-0.988 0.611-1.34 1.248-1.34 0.923 0 1.3 0.494 1.3 1.34v0.195h1.482v-0.209c0-0.961-0.247-2.443-2.626-2.443-1.742 0-2.886 0.936-2.886 2.627 0 1.326 0.584 2.027 1.937 2.547l1.015 0.352c0.832 0.246 1.325 0.676 1.325 1.65 0 0.689-0.468 1.354-1.403 1.354-1.027 0-1.521-0.572-1.521-1.703v-0.234h-1.482v0.221c0 1.301 0.521 2.834 2.821 2.834 1.872 0 3.068-0.818 3.068-2.795 0-1.276-0.573-1.993-1.886-2.459z" fill="#fff"/></svg>`;
const azureSvg =
`<svg width="20" height="20" viewBox="0 0 96 96" xmlns="http://www.w3.org/2000/svg"><defs><linearGradient id="e399c19f-b68f-429d-b176-18c2117ff73c" x1="-1032.172" x2="-1059.213" y1="145.312" y2="65.426" gradientTransform="matrix(1 0 0 -1 1075 158)" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#114a8b"/><stop offset="1" stop-color="#0669bc"/></linearGradient><linearGradient id="ac2a6fc2-ca48-4327-9a3c-d4dcc3256e15" x1="-1023.725" x2="-1029.98" y1="108.083" y2="105.968" gradientTransform="matrix(1 0 0 -1 1075 158)" gradientUnits="userSpaceOnUse"><stop offset="0" stop-opacity=".3"/><stop offset=".071" stop-opacity=".2"/><stop offset=".321" stop-opacity=".1"/><stop offset=".623" stop-opacity=".05"/><stop offset="1" stop-opacity="0"/></linearGradient><linearGradient id="a7fee970-a784-4bb1-af8d-63d18e5f7db9" x1="-1027.165" x2="-997.482" y1="147.642" y2="68.561" gradientTransform="matrix(1 0 0 -1 1075 158)" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#3ccbf4"/><stop offset="1" stop-color="#2892df"/></linearGradient></defs><path fill="url(#e399c19f-b68f-429d-b176-18c2117ff73c)" d="M33.338 6.544h26.038l-27.03 80.087a4.152 4.152 0 0 1-3.933 2.824H8.149a4.145 4.145 0 0 1-3.928-5.47L29.404 9.368a4.152 4.152 0 0 1 3.934-2.825z"/><path fill="#0078d4" d="M71.175 60.261h-41.29a1.911 1.911 0 0 0-1.305 3.309l26.532 24.764a4.171 4.171 0 0 0 2.846 1.121h23.38z"/><path fill="url(#ac2a6fc2-ca48-4327-9a3c-d4dcc3256e15)" d="M33.338 6.544a4.118 4.118 0 0 0-3.943 2.879L4.252 83.917a4.14 4.14 0 0 0 3.908 5.538h20.787a4.443 4.443 0 0 0 3.41-2.9l5.014-14.777 17.91 16.705a4.237 4.237 0 0 0 2.666.972H81.24L71.024 60.261l-29.781.007L59.47 6.544z"/><path fill="url(#a7fee970-a784-4bb1-af8d-63d18e5f7db9)" d="M66.595 9.364a4.145 4.145 0 0 0-3.928-2.82H33.648a4.146 4.146 0 0 1 3.928 2.82l25.184 74.62a4.146 4.146 0 0 1-3.928 5.472h29.02a4.146 4.146 0 0 0 3.927-5.472z"/></svg>`;
const TwitterSvg =
`<svg style="fill: #1DA1F2; vertical-align: middle;" width="20" height="20" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path></svg>`;
const providersAnnouncement = `${azureSvg} Microsoft Azure and ${awsSvg} AWS providers for StackQL available now`;
const gitHubStarAccouncement = `<b>If you like StackQL, give it a ⭐️ on <a target="_blank" rel="noopener noreferrer" href="https://github.com/stackql/stackql">GitHub</a> and follow us on <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/stackql" >Twitter</a></b> ${TwitterSvg}`;
const hacktoberfestAccouncement = `<b>🎃 Join us for <a target="_blank" rel="noopener noreferrer" href="https://github.com/stackql/stackql/issues?q=is%3Aissue+is%3Aopen+label%3Ahacktoberfest">Hacktoberfest</a>`;
const {themes} = require('prism-react-renderer');
const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;
const nightOwlCodeTheme = themes.nightOwl;
// Nav and footer link straight to the canonical pages. The former top-level
// aliases (/install, /stackqldocs, /downloads) are Netlify 301s in
// netlify.toml, not pages, so crawlers see the real site structure rather
// than a ring of redirects.
const footerStackQLItems = [
{
label: 'Documentation',
to: '/',
},
{
label: 'Install',
to: '/installing-stackql',
},
{
label: 'Contact us',
to: '/contact-us',
},
{
label: 'Privacy Policy',
to: '/privacy',
},
{
label: 'Terms of Service',
to: '/terms',
},
{
label: 'Support',
to: '/support',
},
];
// Blog sections. Each is its own @docusaurus/plugin-content-blog instance
// (content in blog/<id>, routes at /blog/<id>) with its own list page,
// sidebar and feeds. The /blog landing page is built from the same list by
// plugins/blog-landing. Pre-split post URLs (/blog/<slug>) are 301'd in
// netlify.toml - see scripts/generate-blog-redirects.js.
const blogSections = [
{
id: 'product',
label: 'Product Announcements',
description: 'New StackQL releases, features and capabilities',
},
{
id: 'providers',
label: 'Provider Announcements',
description: 'New and updated StackQL providers',
},
{
id: 'tutorials',
label: 'Tutorials',
description: 'Practical walkthroughs for cloud operations, security and automation using SQL',
},
];
// Locales. Every locale is a full copy of the site under /<locale>/ (one SPA
// per locale, built into build/<locale>/). A page with no translated source
// under i18n/<locale>/ is served in English at its localized URL (Docusaurus
// falls back to the default locale) and marked noindex by the theme wrappers
// (src/theme/DocItem/Content, src/theme/BlogPostPage, src/theme/BlogListPage)
// until a translation exists. Translations are produced and tracked by the
// scripts under scripts/i18n (see CLAUDE.md, "Internationalization"). Add a
// locale here only once its full pass has been run and verified.
const i18nConfig = {
defaultLocale: 'en',
locales: ['en', 'de', 'zh-Hans'],
localeConfigs: {
en: { label: 'English', htmlLang: 'en' },
de: { label: 'Deutsch', htmlLang: 'de' },
// The URL path is lower case on purpose. Netlify answers a page URL that
// has upper-case letters with a 301 to its lower-case form, so with the
// default /zh-Hans/ every canonical, hreflang and sitemap URL of the
// locale was a redirect, and the page then ran at /zh-hans/ with a
// baseUrl of /zh-Hans/: the language switcher strips the baseUrl from
// the path case-sensitively and linked to //zh-hans/, which a browser
// reads as a host name (November 2026). The locale code, the i18n/
// directory and the lang attribute stay zh-Hans.
'zh-Hans': { label: '简体中文', htmlLang: 'zh-Hans', baseUrl: '/zh-hans/' },
},
};
// The URL path prefix of a locale ('' for the default): its baseUrl when the
// locale sets one, otherwise /<locale>. Always lower case, see above.
const localeUrlPrefix = (locale) =>
locale === i18nConfig.defaultLocale
? ''
: (i18nConfig.localeConfigs[locale].baseUrl || `/${locale}/`).replace(/\/+$/, '');
// What a locale offers crawlers follows from what is translated for it
// (scripts/i18n/config.js, `locales.<l>.sources`): every locale has its own
// sitemap.xml, llms.txt, llms-full.txt and .md companions, and each of them
// covers only the pages that exist in that language. The sitemap does this by
// itself (the untranslated pages are noindex, and the sitemap plugin leaves
// noindex pages out); for the answer engine files, configForLocale() at the
// end of this file excludes the untranslated source sets, so no English copy
// of the AI Reference or of a blog post is published under /<locale>/ to
// compete with the English original. The default locale has everything.
const i18nTooling = require('./scripts/i18n/config.js');
const regionalFlags = require('./src/lib/regionalFlags.js');
function translatedSources(locale) {
if (locale === i18nConfig.defaultLocale) return Object.keys(i18nTooling.sources);
return (i18nTooling.locales[locale] || {}).sources || [];
}
// Route prefixes of every locale ('' for the default), for route patterns
// that must cover each localized copy of the site.
const localeRoutePrefixes = i18nConfig.locales.map(localeUrlPrefix);
for (const prefix of localeRoutePrefixes) {
if (prefix !== prefix.toLowerCase()) {
throw new Error(`locale URL prefix ${prefix} has upper-case letters: set a lower-case baseUrl for that locale in i18nConfig.localeConfigs`);
}
}
const blogSectionNavItems = blogSections.map(({id, label}) => ({
label,
to: `/blog/${id}`,
activeBasePath: `/blog/${id}`,
}));
const blogPlugins = blogSections.map(({id, label, description}) => [
'@docusaurus/plugin-content-blog',
{
id,
path: `blog/${id}`,
routeBasePath: `/blog/${id}`,
// one authors file shared by every instance, relative to the content dir
authorsMapPath: '../authors.yml',
blogTitle: label,
blogDescription: description,
blogSidebarTitle: `All ${label.toLowerCase()}`,
blogSidebarCount: 'ALL',
postsPerPage: 5,
showReadingTime: true,
editUrl: 'https://github.com/stackql/stackql.io/edit/main/',
feedOptions: {
type: 'all',
title: `StackQL Blog - ${label}`,
description,
copyright: `Copyright © ${new Date().getFullYear()} StackQL Studios`,
},
},
]);
const footerMoreItems = [
{
label: 'Providers',
to: '/providers',
},
{
// stackql-deploy has its own site. A straight link, in this tab; the
// former /stackql-deploy meta-refresh stub is a Netlify 301 now.
html: '<a class="footer__link-item" href="https://stackql-deploy.io/">stackql-deploy</a>',
},
{
label: 'Blog',
to: '/blog',
},
{
label: 'Quick Starts',
to: '/quick-starts',
},
{
// The /ai/* surface is kept out of the header on purpose, but with no
// internal link at all Google treated its 44 sitemap URLs as orphans
// ("Discovered - currently not indexed"). One footer link to the
// landing page gives the whole tree a crawl path. configForLocale()
// removes it (matched on `to`) for a locale the AI Reference is not
// translated for.
label: 'AI Reference',
to: '/ai',
},
];
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'StackQL',
staticDirectories: ['static'],
tagline: 'The substrate for AI agents to interact with cloud control planes and data planes using SQL',
url: 'https://stackql.io',
baseUrl: '/',
onBrokenLinks: 'throw',
// Every heading in docs/ and ai-content/ carries an explicit {#id}
// (docusaurus write-heading-ids) so anchors survive translation; a link
// to an anchor that no longer exists fails the build.
onBrokenAnchors: 'throw',
favicon: '/favicon.ico',
organizationName: 'stackql',
projectName: 'stackql.io',
baseUrlIssueBanner: false,
trailingSlash: false,
clientModules: [require.resolve('./src/clientModules/revealTabAnchors.js')],
i18n: i18nConfig,
headTags: [
{
// Picks the regional variant of the English flag in the language
// switcher (AU, NZ, ZA, GB) before the first paint, from the browser's
// language and time zone; see src/lib/regionalFlags.js. Inline, so it
// costs no request, and it leaves the page as served on any error.
tagName: 'script',
attributes: {},
innerHTML: regionalFlags.headScript(),
},
{
tagName: 'link',
attributes: {
rel: 'preconnect',
href: 'https://fonts.googleapis.com',
},
},
{
tagName: 'link',
attributes: {
rel: 'preconnect',
href: 'https://fonts.gstatic.com',
crossorigin: 'anonymous',
},
},
{
tagName: 'link',
attributes: {
rel: 'apple-touch-icon',
sizes: '180x180',
href: '/apple-touch-icon.png',
},
},
{
tagName: 'link',
attributes: {
rel: 'icon',
type: 'image/png',
sizes: '32x32',
href: '/favicon-32x32.png',
},
},
{
tagName: 'link',
attributes: {
rel: 'icon',
type: 'image/png',
sizes: '16x16',
href: '/favicon-16x16.png',
},
},
{
tagName: 'link',
attributes: {
rel: 'manifest',
href: '/site.webmanifest',
},
},
{
tagName: 'link',
attributes: {
rel: 'mask-icon',
href: '/safari-pinned-tab.svg',
color: '#0f4c81',
},
},
],
plugins: [
'@docusaurus/plugin-ideal-image',
'@stackql/docusaurus-plugin-structured-data',
[
'@stackql/docusaurus-plugin-aeo',
{
// 0.5.0 defaults apply: plain-markdown companions, the
// <link rel="alternate" type="text/markdown"> on every page that
// has one, the "## Optional" section in llms.txt pointing at
// llms-full.txt, and the Ask AI button only where a companion
// exists.
// configForLocale() adds a `companions.exclude` per locale for the
// source sets that are not translated for it; llms.txt and
// llms-full.txt are built from the companions, so they follow.
llmsTxt: {
// llms-full.txt is read as a bounded prefix by most agents, so
// keep it to the two reference corpora rather than every blog
// post (1.2 MB otherwise). The blog sections stay in llms.txt.
fullTxt: {
include: [
'docusaurus-plugin-content-docs@ai',
'docusaurus-plugin-content-docs@default',
],
},
instanceSections: {
'docusaurus-plugin-content-docs@ai': { title: 'AI Reference', order: 1 },
'docusaurus-plugin-content-docs@default': { title: 'Documentation', order: 2 },
// one llms.txt section per blog instance, in blogSections order
...Object.fromEntries(blogSections.map(({id, label}, i) => [
`docusaurus-plugin-content-blog@${id}`,
{ title: `Blog - ${label}`, order: 3 + i },
])),
},
},
},
],
[
'@docusaurus/plugin-content-docs',
{
id: 'ai',
path: 'ai-content',
routeBasePath: '/ai',
sidebarPath: false,
editUrl: 'https://github.com/stackql/stackql.io/edit/main/',
},
],
// three blog instances (the preset blog is disabled below) plus the
// /blog landing page that lists the newest posts from each
...blogPlugins,
[
require.resolve('./plugins/blog-landing'),
{
sections: blogSections,
postsPerSection: 5,
},
],
// /providers/<slug> and /registry/<name> are Netlify 301s to the provider
// microsites, generated from the catalog by
// scripts/generate-provider-redirects.js (netlify.toml), not routes.
// /providers.json: the catalog published for the shared chrome in
// ../docusaurus-config (provider microsites, query library).
require.resolve('./plugins/provider-catalog'),
],
presets: [
[
'@docusaurus/preset-classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
// gtag only on Netlify builds - local production builds write gtag codegen
// into .docusaurus, which a concurrently running dev server hot-reloads,
// breaking window.gtag on every route change
...(process.env.NETLIFY === 'true' ? {
gtag: {
trackingID: 'G-M7GH68KJ3F',
anonymizeIP: true,
},
} : {}),
sitemap: {
// lastmod per URL from the source file's last git commit (or the
// page's lastUpdatedAt); changefreq and priority are ignored by
// crawlers and only add noise
lastmod: 'date',
changefreq: null,
priority: null,
// tag, pagination, archive and author routes of every blog
// instance, in every locale: list pages, not content
ignorePatterns: localeRoutePrefixes.flatMap((prefix) => [
`${prefix}/blog/*/tags/**`,
`${prefix}/blog/*/page/**`,
`${prefix}/blog/*/archive`,
`${prefix}/blog/*/authors`,
`${prefix}/blog/*/authors/**`,
`${prefix}/search`,
]),
filename: 'sitemap.xml',
},
pages: {},
docs: {
sidebarPath: require.resolve('./sidebars.js'),
path: 'docs',
// Docs-only site: the docs tree is the site root and docs/index.md
// (slug /) is the homepage. Inbound /docs/* links are 301'd in
// netlify.toml. The query library stays proxied at /docs/query-library/.
routeBasePath: '/',
sidebarCollapsible: true,
showLastUpdateTime: true,
editUrl: 'https://github.com/stackql/stackql.io/edit/main/',
},
// the blog is three plugin instances (blogPlugins above), not the
// preset's single instance
blog: false,
theme: {
customCss: require.resolve('./src/css/global.css'),
},
}),
],
],
markdown: {
mermaid: true,
hooks: {
onBrokenMarkdownLinks: 'warn',
},
},
themes: ['@docusaurus/theme-mermaid'],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
structuredData: {
excludedRoutes: [],
verbose: false,
// TechArticle on every page owned by these content-docs instances
// (except each instance's root), since the default docs instance
// has no URL prefix any more. The prefix list still covers /ai/ for
// plugin versions before 1.6.0.
techArticleRoutePrefixes: ['/ai/'],
techArticleDocsInstances: ['default', 'ai'],
// category index pages (/getting-started, /command-line-usage,
// /quick-starts/*) become linked crumbs rather than leaf-name prefixes
breadcrumbLinkAncestors: true,
// The product the site documents (structured-data 1.7.0): one
// SoftwareSourceCode node in every page's graph, and the defaults
// for the SoftwareApplication node a page opts into with
// `softwareApplication: true` in its front matter (the homepage).
softwareSourceCode: {
name: 'StackQL',
codeRepository: 'https://github.com/stackql/stackql',
programmingLanguage: 'Go',
license: 'https://opensource.org/licenses/MIT',
runtimePlatform: 'macOS, Linux, Windows',
},
softwareApplication: {
name: 'StackQL',
applicationCategory: 'DeveloperApplication',
operatingSystem: 'macOS, Linux, Windows',
license: 'https://opensource.org/licenses/MIT',
downloadUrl: 'https://stackql.io/installing-stackql',
isAccessibleForFree: true,
priceCurrency: 'USD',
},
featuredImageDimensions: {
width: 1200,
height: 627,
},
authors: {
'Jeffrey Aven': {
authorId: '1',
url: 'https://www.linkedin.com/in/jeffreyaven/',
imageUrl: 'https://s.gravatar.com/avatar/f96573d092470c74be233e1dded5376f?s=80',
sameAs: [
'https://www.amazon.com/stores/Jeffrey-Aven/author/B0BSP78VVL',
'https://developers.google.com/community/experts/directory/profile/profile-jeffrey-aven',
'https://www.linkedin.com/in/jeffreyaven/',
'https://www.crunchbase.com/person/jeffrey-aven',
'https://github.com/jeffreyaven',
'https://dev.to/jeffreyaven',
],
},
},
organization: {
sameAs: [
'https://twitter.com/stackql',
'https://www.linkedin.com/company/stackql',
'https://github.com/stackql',
'https://www.youtube.com/@stackql',
'https://hub.docker.com/u/stackql',
],
contactPoint: {
'@type': 'ContactPoint',
contactType: 'customer support',
email: 'info@stackql.io',
telephone: '+61 3 8658 5880',
availableLanguage: 'en',
url: 'https://stackql.io/contact-us',
},
// Google's Organization logo guidance wants an actual logo mark
// (square, >= 112px, legible on white), not a cover image.
logo: {
'@type': 'ImageObject',
inLanguage: 'en-US',
'@id': 'https://stackql.io/#logo',
url: 'https://stackql.io/android-chrome-512x512.png',
contentUrl: 'https://stackql.io/android-chrome-512x512.png',
width: 512,
height: 512,
caption: 'StackQL',
},
address: {
'@type': 'PostalAddress',
addressCountry: 'AU',
postalCode: '3000',
streetAddress: 'Level 24, 570 Bourke Street, Melbourne, Victoria',
},
taxID: 'ABN 65 656 147 054',
},
website: {
inLanguage: 'en-US',
},
webpage: {
inLanguage: 'en-US',
datePublished: '2021-07-01',
},
breadcrumbLabelMap: {
'developers': 'Developers',
'functions': 'Functions',
'aggregate': 'Aggregate',
'datetime': 'Date Time',
'json': 'JSON',
'math': 'Math',
'string': 'String',
'command-line-usage': 'Command Line Usage',
'getting-started': 'Getting Started',
'language-spec': 'Language Specification',
're': 'Regular Expressions',
'mcp': 'MCP',
'quick-starts': 'Quick Starts',
'providers': 'Providers',
'ai': 'AI Reference',
// full-path keys where the segment alone would be ambiguous or
// unreadable; a full-path key wins over a segment key
'/quick-starts/aws': 'AWS',
'/quick-starts/azure': 'Microsoft Azure',
'/quick-starts/google': 'Google Cloud Platform',
'/quick-starts/github': 'GitHub',
'/ai/canonical-definitions': 'Canonical Definitions',
'/ai/comparisons': 'Comparisons',
'/ai/how-tos': 'How-tos',
'/ai/concepts': 'Concepts',
'/ai/faqs': 'FAQs',
'/ai/architecture': 'Architecture',
'/ai/troubleshooting': 'Troubleshooting',
'/ai/industry-positioning': 'Industry Positioning',
'/ai/tutorials': 'Tutorials',
'/ai/providers': 'Providers',
// blog section crumbs, keyed by full path so "providers" here does
// not collide with the /providers catalog page
...Object.fromEntries(blogSections.map(({id, label}) => [`/blog/${id}`, label])),
},
},
metadata: [
{name: 'description', content: 'StackQL is an open-source infrastructure-as-code tool and the substrate for AI agents to communicate with cloud control planes and data planes using SQL.'},
{property: 'og:description', content: 'StackQL is an open-source infrastructure-as-code tool and the substrate for AI agents to communicate with cloud control planes and data planes using SQL.'},
{name: 'robots', content: 'index,follow'},
{name: 'keywords', content: 'stackql, sql, ai agents, agentic ai, infrastructure as code, cloud services, api, devops, control plane, data plane'},
{name: 'twitter:site', content: '@stackql'},
{name: 'twitter:creator', content: '@stackql'},
{name: 'twitter:title', content: 'StackQL - SQL for Cloud Infrastructure and AI Agents'},
{name: 'twitter:description', content: 'StackQL is an open-source infrastructure-as-code tool and the substrate for AI agents to communicate with cloud control planes and data planes using SQL.'},
// og:locale (and og:locale:alternate per other locale) is emitted by
// the theme from each locale's htmlLang
{name: 'og:site_name', content: 'StackQL'},
{name: 'msapplication-TileColor', content: '#2d89ef'},
{name: 'theme-color', content: '#0f4c81'},
{name: 'wot-verification', content: '38f4ae79b091dc8046a0'},
],
announcementBar: {
id: 'support_us',
content: hacktoberfestAccouncement,
backgroundColor: '#A9BCD0',
textColor: '#1A4E82',
isCloseable: true,
},
announcementBarActive: false,
announcementBarLink: "https://github.com/stackql/stackql",
image: '/img/stackql-featured-image.png',
algolia: {
// The application ID provided by Algolia
appId: process.env.ALGOLIA_APP_ID,
// Public API key: it is safe to commit it
apiKey: process.env.ALGOLIA_API_KEY,
indexName: process.env.ALGOLIA_INDEX_NAME,
// Off: it adds facet filters (language, docusaurus_tag) to every query
// and returns nothing if the index was not crawled with the official
// Docusaurus v3 DocSearch config. With more than one locale it is the
// only way to keep German results off English pages and vice versa, so
// turn it on once the crawler config is confirmed to record the `lang`
// facet (Docusaurus docs: delete the index and recrawl if it does not).
contextualSearch: false,
// Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
externalUrlRegex: 'external\\.com|domain\\.com',
// Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
replaceSearchResultPathname: {
from: '/docs/', // or as RegExp: /\/docs\//
to: '/',
},
// 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: false,
// Optional: whether you want to use the new Ask AI feature (undefined by default)
askAi: process.env.ALGOLIA_AGENTID,
//... other Algolia params
},
docs: {
sidebar: {
hideable: true,
}
},
navbar: {
logo: {
alt: 'StackQL',
href: '/',
src: 'img/logo-original.svg',
srcDark: 'img/logo-white.svg',
},
items: [
{
to: '/installing-stackql',
label: 'Install',
position: 'left',
},
{
type: 'dropdown',
label: 'AI Agents',
to: '/ai-agents',
position: 'left',
items: [
{
to: '/command-line-usage/mcp',
label: 'MCP Server',
},
{
to: '/mcp',
label: 'MCP Tools',
},
{
to: '/mcp/embedded',
label: 'Embedded MCP',
},
{
// Separate site proxied under this path via the Netlify 200
// rewrite. pathname:// renders a plain anchor (full page load,
// no SPA route, no broken-link check); html label instead of
// label suppresses the external-link icon (same-domain URL);
// target keeps it in the same tab.
href: 'pathname:///docs/query-library/',
html: 'Query Library',
target: '_self',
},
// {
// to: 'blog/tags/ai',
// label: 'AI Resources',
// },
],
},
{
// stackql-deploy has its own site: a plain anchor there, in this
// tab (html instead of label suppresses the external-link icon,
// as for the Query Library). The former /stackql-deploy
// meta-refresh stub is a Netlify 301 now.
href: 'https://stackql-deploy.io/',
html: 'stackql-deploy',
target: '_self',
rel: 'noopener',
position: 'left',
},
{
// Two-level menu (category -> provider) generated from the
// provider catalog (src/configs/providers.json) by the custom
// navbar item type in src/theme/NavbarItem. The catalog also
// drives the tiles on /providers and the /providers/<slug> and
// /registry/<name> 301s (scripts/generate-provider-redirects.js).
type: 'custom-providersDropdown',
label: 'Providers',
to: '/providers',
position: 'left',
},
{
type: 'dropdown',
label: 'Blog',
to: '/blog',
position: 'left',
items: [
...blogSectionNavItems,
{
to: '/quick-starts',
label: 'Quick Starts',
activeBasePath: '/quick-starts',
},
],
},
//
// to: 'blog',
// label: 'Blog',
// position: 'left',
// activeBasePath: 'blog',
// },
{
type: 'localeDropdown',
position: 'right',
},
{
href: 'https://github.com/stackql/stackql',
position: 'right',
className: 'header-github-link',
'aria-label': 'GitHub repository',
},
],
},
footer: {
style: 'dark',
logo: {
alt: 'StackQL',
href: '/',
src: 'img/logo-original.svg',
srcDark: 'img/logo-white.svg',
},
links: [
{
title: 'StackQL',
items: footerStackQLItems,
},
{
title: 'More',
items: footerMoreItems,
},
],
copyright: `© ${new Date().getFullYear()} StackQL Studios ABN 65 656 147 054`,
},
colorMode: {
// using user system preferences, instead of the hardcoded defaultMode
respectPrefersColorScheme: true,
},
prism: {
additionalLanguages: ['powershell'],
//theme: lightCodeTheme,
darkTheme: darkCodeTheme,
theme: (() => {
var theme = nightOwlCodeTheme;
// Add additional rule to nightowl theme in order to change
// the color of YAML keys (to be different than values).
// There weren't many Prism themes that differentiated
// YAML keys and values. See link:
// https://github.com/FormidableLabs/prism-react-renderer/tree/master/src/themes
theme.styles.push({
types: ["atrule"],
style: {
// color chosen from the nightowl theme palette
// https://github.com/FormidableLabs/prism-react-renderer/blob/master/src/themes/nightOwl.js#L83
color: "rgb(255, 203, 139)"
}
});
return theme
})(),
},
}),
};
// The config for one locale: `config` as written above, with the source sets
// that are not translated for that locale kept out of the answer engine
// files (see translatedSources). Returns copies; the `config` object is
// shared by every locale of a build and is not modified.
function configForLocale(locale) {
const sources = translatedSources(locale);
const hasAiReference = sources.includes('ai-content');
// routes of the untranslated source sets, as companions.exclude patterns
// (a pattern matches with or without the locale's base URL in front)
const untranslated = [
...(hasAiReference ? [] : ['/ai', '/ai/**']),
...blogSections
.filter(({id}) => !sources.includes(`blog-${id}`))
.flatMap(({id}) => [`/blog/${id}`, `/blog/${id}/**`]),
];
if (untranslated.length === 0) return config;
return {
...config,
plugins: config.plugins.map((plugin) =>
Array.isArray(plugin) && plugin[0] === '@stackql/docusaurus-plugin-aeo'
? [plugin[0], {
...plugin[1],
companions: {
...plugin[1].companions,
exclude: [...((plugin[1].companions || {}).exclude || []), ...untranslated],
},
}]
: plugin),
themeConfig: hasAiReference
? config.themeConfig
: {
...config.themeConfig,
footer: {
...config.themeConfig.footer,
links: config.themeConfig.footer.links.map((column) => ({
...column,
items: column.items.filter((item) => item.to !== '/ai'),
})),
},
},
};
}
// Exported as a function on purpose. `docusaurus build` builds the locales
// one after another in one process and sets DOCUSAURUS_CURRENT_LOCALE before
// it loads this file for each of them, but the module is evaluated only
// once: a top-level read of that variable keeps the first locale's value for
// all the others (tried, and the German build came out with the English
// settings). Docusaurus calls an exported function on every load. Commands
// that do not set the variable (write-translations) get the default locale.
module.exports = function createConfig() {
return configForLocale(process.env.DOCUSAURUS_CURRENT_LOCALE || i18nConfig.defaultLocale);
};
function fetchHeadTagsFromAPI() {
throw new Error('Function not implemented.');
}