-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocusaurus.config.js
More file actions
214 lines (197 loc) · 6.21 KB
/
docusaurus.config.js
File metadata and controls
214 lines (197 loc) · 6.21 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
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const {themes: prismThemes} = require('prism-react-renderer');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Vantage Compute Documentation',
tagline: 'High Performance Computing, Evolved',
favicon: 'img/favicon.ico',
url: 'https://docs.vantagecompute.ai',
baseUrl: '/',
organizationName: 'vantagecompute',
projectName: 'vantage-docs',
deploymentBranch: 'main',
trailingSlash: false,
onBrokenLinks: 'warn',
onBrokenAnchors: 'warn',
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
scripts: [
// Error suppression for browser extensions
'/js/error-suppression.js'
],
headTags: [
// Preconnect to Algolia for performance optimization
{
tagName: 'link',
attributes: {
rel: 'preconnect',
href: 'https://MPYYYNENH9-dsn.algolia.net',
crossorigin: 'anonymous',
},
},
],
markdown: {
format: 'detect',
mermaid: true,
hooks: {
onBrokenMarkdownLinks: 'warn'
}
},
themes: ['@docusaurus/theme-mermaid'],
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve('./sidebars-main.js'),
rehypePlugins: [
require('./src/rehypeTabsTransform.js'),
// [require('rehype-external-links').default, { target: '_blank', rel: ['noopener', 'noreferrer'] }],
],
routeBasePath: '/', // Make docs the root
},
blog: false,
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
],
],
plugins: [
[
'@docusaurus/plugin-ideal-image',
{
quality: 100,
sizes: [200, 500],
disableInDev: false,
},
],
[
'docusaurus-plugin-llms',
{
// Options here
generateLLMsTxt: true,
generateLLMsFullTxt: true,
docsDir: '.',
ignoreFiles: ['node_modules/**', 'build/**', '.git/**', '**/node_modules/**'],
title: 'Vantage Compute Documentation',
description: 'Complete reference documentation for Vantage Compute platform, CLI, API, and SDK.',
includeBlog: false,
// Content cleaning options
excludeImports: true,
removeDuplicateHeadings: true,
// Disable individual markdown files to avoid filename issues
generateMarkdownFiles: false,
// Control documentation order
includeOrder: [
'docs/**',
],
includeUnmatchedLast: true,
// Path transformation options
pathTransformation: {
// Paths to ignore when constructing URLs (will be removed if found)
ignorePaths: ['docs'],
// Paths to add when constructing URLs (will be prepended if not already present)
// addPaths: ['api'],
},
// Custom LLM files for specific documentation sections
customLLMFiles: [
{
filename: 'llms-vantage-api.txt',
includePatterns: ['docs/developer-tools/api/*.md', 'docs/developer-tools/api/**/*.md'],
fullContent: true,
title: 'Vantage API Documentation',
description: 'Complete reference for Vantage API'
},
{
filename: 'llms-vantage-cli.txt',
includePatterns: ['docs/developer-tools/cli/*.md', 'docs/developer-tools/cli/**/*.md'],
fullContent: false,
title: 'Vantage CLI Documentation',
description: 'All Vantage CLI commands in a single file'
},
{
filename: 'llms-vantage-sdk.txt',
includePatterns: ['docs/developer-tools/sdk/*.md', 'docs/developer-tools/sdk/**/*.md'],
fullContent: false,
title: 'Vantage SDK Documentation',
description: 'All Vantage SDK references in a single file'
},
{
filename: 'llms-vantage-platform.txt',
includePatterns: ['docs/clusters/**/*.md', 'docs/jobs/**/*.md', 'docs/workbench/**/*.md', 'docs/storage/**/*.md', 'docs/licenses/**/*.md', 'docs/teams/**/*.md', 'docs/settings/**/*.md'],
fullContent: false,
title: 'Vantage Platform Documentation',
description: 'All Vantage Platform references in a single file'
},
],
},
],
],
themeConfig: {
image: 'img/preview.png',
algolia: {
appId: 'MPYYYNENH9',
apiKey: 'b3cadb2f7da0194ead335c3488237443',
indexName: 'VantageComputeDocsWebCrawler',
insights: true,
// Disabled: we have one locale/version, so contextual facet filters
// would silently return 0 results if the crawler didn't set them.
contextualSearch: false,
// Not needed: docs are served from root (routeBasePath: '/'),
// so crawler URLs already match the live site paths.
// replaceSearchResultPathname: { from: '/docs/', to: '/' },
searchParameters: {},
searchPagePath: 'search',
searchHotkeys: ['ctrl+k', 'cmd+k'],
},
navbar: {
title: "",
logo: {
alt: 'Vantage Compute Logo',
src: 'https://vantage-compute-public-assets.s3.us-east-1.amazonaws.com/branding/vantage-logo-text-white-horz.png',
srcDark: 'https://vantage-compute-public-assets.s3.us-east-1.amazonaws.com/branding/vantage-logo-text-white-horz.png',
href: 'https://docs.vantagecompute.ai',
target: '_self'
},
items: [
{type: 'search', position: 'right'},
{
type: 'custom-askAI',
position: 'right',
},
],
hideOnScroll: false
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
tableOfContents: {
minHeadingLevel: 2,
maxHeadingLevel: 5,
},
metadata: [
{
name: 'vantage-docs-version',
content: process.env.REACT_APP_VERSION,
},
],
docs: {
sidebar: {
hideable: true,
autoCollapseCategories: true,
},
},
colorMode: {
defaultMode: 'light',
disableSwitch: false,
respectPrefersColorScheme: true,
},
},
};
module.exports = config;