Repository navigation
Expand file tree
/
Copy pathdocusaurus.config.ts
More file actions
421 lines (404 loc) · 14.6 KB
/
Copy pathdocusaurus.config.ts
File metadata and controls
421 lines (404 loc) · 14.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
import path from 'path';
//import { themes as prismThemes } from 'prism-react-renderer';
import type { Config } from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import PrismLight from './src/utils/prismLight';
import PrismDark from './src/utils/prismDark';
import crdReferenceRemark from './plugins/crd-reference-remark/index.mjs';
import { getCrdSets } from './scripts/lib/crd-sets.mjs';
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
// Only load tracking/analytics scripts in Vercel production deployments.
// This keeps HubSpot, GTM/Stape, and Thred disabled during local development
// (`npm run start`) and on Vercel preview deployments, avoiding cookie banners,
// chatbot widgets, and polluted analytics data.
const isProductionDeploy = process.env.VERCEL_ENV === 'production';
const config: Config = {
title: 'Stacklok Docs',
tagline: 'Run, govern, and secure your AI agents, tools, and models',
favicon: 'img/stacklok-favicon.svg',
plugins: [
'@docsearch/docusaurus-adapter',
[
'vercel-analytics',
{
debug: false,
},
],
[
'./plugins/mcp-metadata-plugin',
{
thvCommand: 'thv', // Can be customized if thv is in a different path
failOnError:
process.env.NODE_ENV === 'production' || process.env.CI === 'true',
},
],
[
'@signalwire/docusaurus-plugin-llms-txt',
{
depth: 2,
content: {
includeBlog: false,
includePages: true,
includeDocs: true,
includeGeneratedIndex: false,
enableLlmsFullTxt: false,
enableMarkdownFiles: true,
excludeRoutes: [
'/search',
'/theme-preview',
'/toolhive/reference/*api',
'/toolhive/reference/registry-schema-*',
],
routeRules: [
{
route: '/toolhive/*',
depth: 1,
},
],
},
includeOrder: [
'/toolhive/concepts/**',
'/toolhive/guides-*',
'/toolhive/tutorials/**',
'/toolhive/integrations/**',
'/toolhive/reference/**',
],
optionalLinks: [
{
title: 'Stacklok website',
url: 'https://stacklok.com',
description:
'Official website of Stacklok, the creators of ToolHive.',
},
{
title: 'Community Discord',
url: 'https://discord.gg/stacklok',
},
],
},
],
function googleTagManager() {
return {
name: 'google-tag-manager',
injectHtmlTags() {
if (!isProductionDeploy) return {};
return {
headTags: [
{
tagName: 'script',
// Server-side GTM loader script.
// Source: Generated from the Stape dashboard for Stacklok.
// The snippet is intentionally kept minified and should not be edited manually.
// To update, re-generate from the Stape dashboard and replace the string verbatim.
innerHTML:
'!function(){"use strict";function l(e){for(var t=e,r=0,n=document.cookie.split(";");r<n.length;r++){var o=n[r].split("=");if(o[0].trim()===t)return o[1]}}function s(e){return localStorage.getItem(e)}function u(e){return window[e]}function A(e,t){e=document.querySelector(e);return t?null==e?void 0:e.getAttribute(t):null==e?void 0:e.textContent}var e=window,t=document,r="script",n="dataLayer",o="https://mm.stacklok.com",a="",i="3ghsgqgovzfj",c="2ng=AwJHMTsqXDBTKyIxOyFIQRxbSFheQRUJVxUOFwwMHQgBSBkZAg%3D%3D",g="cookie",v="user_id",E="",d=!1;try{var d=!!g&&(m=navigator.userAgent,!!(m=new RegExp("Version/([0-9._]+)(.*Mobile)?.*Safari.*").exec(m)))&&16.4<=parseFloat(m[1]),f="stapeUserId"===g,I=d&&!f?function(e,t,r){void 0===t&&(t="");var n={cookie:l,localStorage:s,jsVariable:u,cssSelector:A},t=Array.isArray(t)?t:[t];if(e&&n[e])for(var o=n[e],a=0,i=t;a<i.length;a++){var c=i[a],c=r?o(c,r):o(c);if(c)return c}else console.warn("invalid uid source",e)}(g,v,E):void 0;d=d&&(!!I||f)}catch(e){console.error(e)}var m=e,g=(m[n]=m[n]||[],m[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"}),t.getElementsByTagName(r)[0]),v=I?"&bi="+encodeURIComponent(I):"",E=t.createElement(r),f=(d&&(i=8<i.length?i.replace(/([a-z]{8}$)/,"kp$1"):"kp"+i),!d&&a?a:o);E.async=!0,E.src=f+"/"+i+".js?"+c+v,null!=(e=g.parentNode)&&e.insertBefore(E,g)}();',
},
],
preBodyTags: [
// Server-side GTM noscript fallback.
`<!-- Google Tag Manager (noscript) --><noscript><iframe src="https://mm.stacklok.com/ns.html?id=GTM-W9MXGTF9" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><!-- End Google Tag Manager (noscript) -->`,
],
};
},
};
},
],
// Set the production url of your site here
url: 'https://docs.stacklok.com',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'stacklok', // Usually your GitHub org/user name.
projectName: 'docs-website', // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenAnchors: 'warn',
// 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'],
},
markdown: {
mermaid: true,
mdx1Compat: {
comments: false,
admonitions: false,
headingIds: true,
},
hooks: {
onBrokenMarkdownLinks: 'warn',
onBrokenMarkdownImages: 'throw',
},
},
future: {
v4: {
removeLegacyPostBuildHeadAttribute: true,
useCssCascadeLayers: true,
},
faster: {
swcJsLoader: false, // Disabled due to https://github.com/rohit-gohri/redocusaurus/issues/388
swcJsMinimizer: true,
swcHtmlMinimizer: true,
lightningCssMinimizer: true,
rspackBundler: true,
rspackPersistentCache: true,
ssgWorkerThreads: true,
mdxCrossCompilerCache: true,
},
},
themes: ['@docusaurus/theme-mermaid', 'docusaurus-json-schema-plugin'],
presets: [
[
'classic',
{
docs: {
routeBasePath: '/',
sidebarPath: './sidebars.ts',
// Remove this to remove the "edit this page" links.
editUrl: 'https://github.com/stacklok/docs-website/tree/main/',
// Populate lastUpdatedAt metadata for JSON-LD structured data.
// The rendered timestamp is hidden via CSS (.theme-last-updated).
showLastUpdateTime: true,
admonitions: {
keywords: ['enterprise'],
extendDefaults: true,
},
// Must run before Docusaurus's default TOC extractor so the
// headings injected for <CRDReference> make it into the TOC.
beforeDefaultRemarkPlugins: [
[
crdReferenceRemark,
{
// Derived from the CRD sets declared in
// .github/upstream-projects.yaml - no hardcoded list to keep
// in sync when a set is added.
schemaDirs: getCrdSets().map((s) =>
path.resolve(__dirname, s.out)
),
},
],
],
},
blog: {
blogTitle: 'ToolHive Updates and Announcements',
blogDescription:
'Stay up to date with the latest ToolHive news, project updates, and announcements.',
path: 'blog/toolhive-updates',
routeBasePath: 'toolhive/updates',
blogSidebarCount: 10,
showReadingTime: false,
},
theme: {
customCss: [require.resolve('./src/css/custom.css')],
},
} satisfies Preset.Options,
],
[
'redocusaurus',
{
specs: [
{
id: 'toolhive-api',
spec: 'static/api-specs/toolhive-api.yaml',
url: '/api-specs/toolhive-api.yaml',
normalizeUrl: false,
config: path.join(__dirname, 'src/redocly/redocly-toolhive.yaml'),
},
{
id: 'toolhive-registry-api',
spec: 'static/api-specs/toolhive-registry-api.yaml',
config: path.join(__dirname, 'src/redocly/redocly-toolhive.yaml'),
},
{
id: 'enterprise-manager-api',
spec: 'static/api-specs/enterprise-manager-api.json',
config: path.join(__dirname, 'src/redocly/redocly-toolhive.yaml'),
},
{
id: 'connector-gateway-api',
spec: 'static/api-specs/connector-gateway-api.json',
config: path.join(__dirname, 'src/redocly/redocly-toolhive.yaml'),
},
{
id: 'ai-gateway-management-api',
spec: 'static/api-specs/ai-gateway-management-api.yaml',
config: path.join(__dirname, 'src/redocly/redocly-toolhive.yaml'),
},
],
theme: {
primaryColor: '#2d684b',
primaryColorDark: '#bddfc2',
options: {
sortTagsAlphabetically: true,
sortOperationsAlphabetically: true,
theme: {
colors: {
responses: {
success: { color: 'var(--api-response-success)' },
error: { color: 'var(--api-response-error)' },
},
},
},
},
},
},
],
],
themeConfig: {
colorMode: {
defaultMode: 'dark',
disableSwitch: false,
respectPrefersColorScheme: true,
},
// Replace with your project's social card
// image: 'img/docusaurus-social-card.jpg',
docs: {
sidebar: {
hideable: false,
autoCollapseCategories: true,
},
},
navbar: {
logo: {
alt: 'Stacklok logo',
src: 'img/logos/stacklok-default-light-green.svg',
href: '/',
},
items: [
{
type: 'docSidebar',
sidebarId: 'platformSidebar',
label: 'Stacklok Platform',
position: 'left',
},
{
type: 'docSidebar',
sidebarId: 'mcpSidebar',
label: 'ToolHive MCP & skills',
position: 'left',
},
{
type: 'docSidebar',
sidebarId: 'aiGatewaySidebar',
label: 'AI Gateway',
position: 'left',
},
{
type: 'docSidebar',
sidebarId: 'connectorGatewaySidebar',
label: 'Connector Gateway',
position: 'left',
},
{
type: 'docSidebar',
sidebarId: 'resourcesSidebar',
label: 'Resources',
position: 'left',
},
/* {
to: '/toolhive/updates',
label: 'Updates',
position: 'left',
}, */
{
href: 'https://github.com/stacklok',
className: 'navbar-icon-link fa-brands fa-github fa-lg',
position: 'right',
'aria-label': 'Stacklok on GitHub',
},
{
href: 'https://discord.gg/stacklok',
className: 'navbar-icon-link fa-brands fa-discord fa-lg',
position: 'right',
'aria-label': 'Join Stacklok on Discord',
},
{
href: 'https://youtube.com/@stacklok',
className: 'navbar-icon-link fa-brands fa-youtube fa-lg',
position: 'right',
'aria-label': 'Stacklok on YouTube',
},
],
},
footer: {
links: [
{
items: [
{
html: `<a href="https://stacklok.com/"><img src="/img/logos/stacklok-default-light-green.svg" alt="Stacklok Logo" width="150px" /></a>`,
},
],
},
{
items: [
{
html: `<div style="display: flex;">
<a href="https://github.com/stacklok" target="_blank" class="footer__icon--custom" aria-label="Stacklok on GitHub"><i class="fa-brands fa-github fa-xl"></i></a>
<a href="https://discord.gg/stacklok" target="_blank" class="footer__icon--custom" aria-label="Join Stacklok on Discord"><i class="fa-brands fa-discord fa-xl"></i></a>
<a href="https://youtube.com/@stacklok" target="_blank" class="footer__icon--custom" aria-label="Stacklok on YouTube"><i class="fa-brands fa-youtube fa-xl"></i></a>
<a href="https://linkedin.com/company/stacklok" target="_blank" class="footer__icon--custom" aria-label="Stacklok on LinkedIn"><i class="fa-brands fa-linkedin fa-xl"></i></a>
<a href="https://x.com/stacklokHQ" target="_blank" class="footer__icon--custom" aria-label="Stacklok on X (Twitter)"><i class="fa-brands fa-x-twitter fa-xl"></i></a>
</div>`,
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Stacklok, Inc.`,
},
prism: {
theme: PrismLight,
darkTheme: PrismDark,
additionalLanguages: [
'bash',
'json',
'powershell',
'docker',
'promql',
'hcl',
],
},
mermaid: {
theme: { light: 'neutral', dark: 'dark' },
options: {
themeVariables: {
fontFamily: 'Figtree, system-ui, sans-serif',
primaryColor: '#2d684b',
primaryBorderColor: '#2d684b',
primaryTextColor: '#f9faf9',
lineColor: '#2d684b',
secondaryColor: '#f3e6ee',
// Base styling
mainBkg: '#2d684b',
noteBkgColor: '#444444',
noteTextColor: '#f9faf9',
// BEGIN flowchart styles
nodeTextColor: '#f9faf9',
// BEGIN sequenceDiagram styles
actorBorder: '#2d684b',
actorLineColor: '#2d684b',
actorTextColor: '#f9faf9',
activationBkgColor: '#2d684b',
activationBorderColor: '#2d684b',
labelBoxBkgColor: '#444444',
labelTextColor: '#f9faf9',
},
},
},
docsearch: {
appId: '5VBG92C77M',
apiKey: '95606dace0984ad5f2e16f4b4bf0699a',
indices: [{ name: 'stacklok' }],
askAi: {
agentId: '08e651d3-71c6-4394-85e9-71450ee93578',
promptSuggestions: {
indexName: 'stacklok-markdown_prompt_suggestions',
},
},
contextualSearch: true,
},
} satisfies Preset.ThemeConfig,
};
export default config;