-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocusaurus.config.ts
More file actions
290 lines (276 loc) · 8.88 KB
/
docusaurus.config.ts
File metadata and controls
290 lines (276 loc) · 8.88 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
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: 'CodeBolt',
tagline: 'AI-native coding environment with multi-agent orchestration, MCP tooling, and extensible agent architecture',
favicon: 'img/favicon.ico',
// Set the production url of your site here
url: 'https://docs.codebolt.ai',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',
trailingSlash: false,
markdown: {
mermaid: true,
format: 'mdx',
hooks: {
onBrokenMarkdownLinks: 'warn',
},
},
// Typedoc-generated content has thousands of inherited-property cross-
// references whose anchor IDs don't survive Docusaurus's normalization
// (collisions with sibling properties, inherited-member mangling, etc.).
// These are internal to the auto-generated reference and not navigation
// any reader clicks — ignoring them keeps the build clean.
onBrokenAnchors: 'ignore',
customFields: {
onDuplicatePresets: 'warn',
onExtraPlugins: 'warn',
},
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'codeboltai', // Usually your GitHub org/user name.
projectName: 'codeboltai.github.io', // Usually your repo name.
onBrokenLinks: 'warn',
headTags: [
{
tagName: 'meta',
attributes: {
name: 'twitter:card',
content: 'summary_large_image',
},
},
{
tagName: 'meta',
attributes: {
name: 'twitter:site',
content: '@codeboltai',
},
},
{
tagName: 'meta',
attributes: {
name: 'twitter:image',
content: 'https://docs.codebolt.ai/img/docusaurus-social-card.jpg',
},
},
{
tagName: 'script',
attributes: { type: 'application/ld+json' },
innerHTML: JSON.stringify({
'@context': 'https://schema.org',
'@type': 'WebSite',
name: 'CodeBolt Documentation',
url: 'https://docs.codebolt.ai',
description: 'AI-native coding environment with multi-agent orchestration, MCP tooling, and extensible agent architecture',
}),
},
],
// 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'],
},
plugins: [
'docusaurus-plugin-image-zoom',
// Force-exit after build completes. Disabled because it can terminate the
// process before other post-build plugins, including the sitemap
// generator, finish writing their output.
// function forceExitAfterBuild() {
// return {
// name: 'force-exit-after-build',
// async postBuild() {
// setImmediate(() => process.exit(0));
// },
// };
// },
// Webpack's persistent filesystem cache (IdleFileCachePlugin) hangs during
// shutdown-serialize on Windows with this repo. A production build is
// one-shot, so disabling the cache trades a small speed hit for a clean
// exit without killing post-build plugin work.
// function disableWebpackFsCache() {
// return {
// name: 'disable-webpack-fs-cache',
// configureWebpack() {
// return { cache: false };
// },
// };
// },
],
themes: [
'@docusaurus/theme-mermaid',
[
'@easyops-cn/docusaurus-search-local',
{
hashed: true,
language: ['en'],
highlightSearchTermsOnTargetPage: true,
explicitSearchResultPath: true,
docsRouteBasePath: '/docs',
indexBlog: true,
indexDocs: true,
// Exclude auto-generated type-reference pages from the search index.
// They balloon the index past Cloudflare Workers' 25 MiB per-asset cap
// and add little search value (most are interface dumps).
ignoreFiles: [
/reference\//,
],
},
],
],
presets: [
[
'classic',
{
docs: {
sidebarPath: './sidebars.ts',
// Exclude auto-generated reference from the dev server file watcher.
// 05_reference/ contains ~4500 TypeDoc-generated files that cause the
// watcher to re-index on every save and make hot reload unusably slow.
// They are still included in production builds — remove this line to
// regenerate a full build locally.
exclude: process.env.NODE_ENV === 'development'
? ['05_reference/**']
: ['Issue.md', 'sortspec.md', 'Excalidraw/**'],
// editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
async sidebarItemsGenerator({ defaultSidebarItemsGenerator, item, ...args }) {
const sidebarItems = await defaultSidebarItemsGenerator({ item, ...args });
if (item.dirName !== '02_using-codebolt') return sidebarItems;
const result: typeof sidebarItems = [];
for (const sidebarItem of sidebarItems) {
const label = (sidebarItem as any).customProps?.sectionLabel;
if (sidebarItem.type === 'category' && label) {
result.push({
type: 'html',
value: `<div class="sidebar-section-rule"></div>`,
defaultStyle: false,
} as any);
}
result.push(sidebarItem);
}
return result;
},
},
blog: {
showReadingTime: true,
feedOptions: {
type: 'rss',
title: 'Codebolt Blog',
description: 'Updates, guides, and news about Codebolt',
copyright: `Copyright ${new Date().getFullYear()} Codebolt`,
},
// editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
},
sitemap: {
lastmod: 'date',
changefreq: 'weekly',
priority: 0.5,
ignorePatterns: [
'/tags/**',
'/docs/reference/**',
],
},
theme: {
customCss: './src/css/custom.css',
},
} satisfies Preset.Options,
],
],
themeConfig: {
colorMode: {
defaultMode: 'dark',
respectPrefersColorScheme: false,
disableSwitch: false,
},
docs: {
sidebar: {
autoCollapseCategories: true,
},
},
mermaid: {
theme: { light: 'neutral', dark: 'dark' },
},
image: 'img/docusaurus-social-card.jpg',
navbar: {
title: 'CodeBolt',
logo: {
alt: 'CodeBolt Logo',
src: 'img/logo.jpg',
},
items: [
{
type: 'docSidebar',
sidebarId: 'usingCodeboltSidebar',
position: 'left',
label: 'Using Codebolt',
},
{
type: 'docSidebar',
sidebarId: 'conceptsSidebar',
position: 'left',
label: 'Concepts',
},
{
type: 'docSidebar',
sidebarId: 'guidesSidebar',
position: 'left',
label: 'Guides',
},
{
type: 'docSidebar',
sidebarId: 'buildSidebar',
position: 'left',
label: 'Build on Codebolt',
},
// Reference sidebar is excluded in dev (05_reference files not watched).
// In dev we show a plain href so the navbar doesn't break.
...(process.env.NODE_ENV === 'development'
? [{ type: 'html' as const, value: '<span class="navbar__item navbar__link" style="opacity:0.4;cursor:default">Reference</span>', position: 'left' as const }]
: [{ type: 'docSidebar' as const, sidebarId: 'referenceSidebar', position: 'left' as const, label: 'Reference' }]
),
// {
// type: 'docSidebar',
// sidebarId: 'devSidebar',
// position: 'left',
// label: 'Developer Guide',
// },
// {
// type: 'docSidebar',
// sidebarId: 'toolSidebar',
// position: 'left',
// label: 'Tools',
// },
// {
// type: 'docSidebar',
// sidebarId: 'appSidebar',
// position: 'left',
// label: 'Apps',
// },
{
to: '/blog',
label: 'Blog',
position: 'left'
},
],
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.vsDark,
},
zoom: {
selector: '.theme-doc-markdown img',
background: {
light: 'rgba(245, 244, 237, 0.92)',
dark: 'rgba(20, 20, 18, 0.92)',
},
config: {
margin: 32,
scrollOffset: 0,
},
},
} satisfies Preset.ThemeConfig,
};
export default config;