-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathdocusaurus.config.ts
More file actions
291 lines (280 loc) · 7.38 KB
/
Copy pathdocusaurus.config.ts
File metadata and controls
291 lines (280 loc) · 7.38 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
import { themes as prismThemes } from 'prism-react-renderer'
import type { Config } from '@docusaurus/types'
import type * as Preset from '@docusaurus/preset-classic'
import { redirects, createRedirects } from './redirects' // Add this line
const config: Config = {
title: 'Bacalhau',
tagline: 'Distributed Compute Over Data',
favicon: 'img/favicon.png',
url: 'https://bacalhau.org',
baseUrl: '/',
// true = pages served at /path/ (with slash), /path redirects → /path/
// Fixes GitHub Pages 404s when Google crawls slash variants of URLs
trailingSlash: true,
// GitHub pages deployment config.
organizationName: 'bacalhau-project', // Usually your GitHub org/user name.
projectName: 'docs', // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenAnchors: 'throw',
onDuplicateRoutes: 'throw',
markdown: {
format: 'detect',
hooks: {
onBrokenMarkdownLinks: 'throw',
},
},
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
plugins: [
[
'@docusaurus/plugin-client-redirects',
{
redirects: redirects,
createRedirects: createRedirects,
},
],
[
'@docusaurus/plugin-content-docs',
{
id: 'useCases',
path: 'content/use-cases',
routeBasePath: '/',
sidebarPath: require.resolve('./sidebarsUseCases.ts'),
},
],
[
'@docusaurus/plugin-content-docs',
{
id: 'community',
path: 'content/community',
routeBasePath: '/community',
sidebarPath: require.resolve('./sidebarsCommunity.ts'),
},
],
],
presets: [
[
'classic',
{
docs: {
path: 'docs',
routeBasePath: 'docs',
sidebarPath: require.resolve('./sidebarsDocs.ts'),
editUrl: 'https://github.com/bacalhau-project/docs/tree/main/',
showLastUpdateTime: true,
},
theme: {
customCss: './src/css/custom.css',
},
googleTagManager: {
containerId: 'GTM-M4ZC5QX7',
},
sitemap: {
changefreq: 'weekly',
priority: 0.5,
// Exclude pages that have noindex or are not useful for search
ignorePatterns: [
'/search',
'/search/**',
'/tags/**',
'/docs/tags/**',
'/community/tags/**',
],
filename: 'sitemap.xml',
},
} satisfies Preset.Options,
],
],
headTags: [
{
tagName: 'script',
attributes: {
type: 'application/ld+json',
},
innerHTML: JSON.stringify({
'@context': 'https://schema.org',
'@type': 'SoftwareSourceCode',
name: 'Bacalhau',
url: 'https://bacalhau.org/',
codeRepository: 'https://github.com/bacalhau-project/bacalhau',
license: 'https://www.apache.org/licenses/LICENSE-2.0',
programmingLanguage: 'Go',
description:
'Open-source distributed compute orchestration software that runs workloads near the data they process.',
keywords: [
'compute over data',
'distributed computing',
'data locality',
'edge computing',
'workload orchestration',
],
}),
},
{
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: 'stylesheet',
href: 'https://fonts.googleapis.com/css2?family=Nunito:wght@400;500;600;700;800;900&family=Nunito+Sans:wght@400;500;600;700;800;900&display=swap',
},
},
],
themeConfig: {
colorMode: {
defaultMode: 'dark',
disableSwitch: true,
respectPrefersColorScheme: false,
},
// Replace with your project's social card
image: 'img/bacalhau-social.png',
algolia: {
appId: 'K2MK84JXCM',
apiKey: '00017896a702f2a79cf8b89a9dec5905',
indexName: 'bacalhau',
searchPagePath: 'search',
insights: true,
placeholder: 'Search Bacalhau...'
},
navbar: {
title: 'Bacalhau',
logo: {
alt: 'Bacalhau Logo',
src: 'img/logos/logo.svg',
srcDark: 'img/logos/logo-dark.svg',
},
items: [
{
type: 'docSidebar',
sidebarId: 'docs',
position: 'left',
label: 'Docs',
},
{
type: 'docSidebar',
sidebarId: 'useCases',
docsPluginId: 'useCases',
position: 'left',
label: 'Use Cases',
},
{
type: 'docSidebar',
sidebarId: 'cliApi',
position: 'left',
label: 'CLI & API',
},
{
type: 'docSidebar',
sidebarId: 'reference',
position: 'left',
label: 'References',
},
{
type: 'docSidebar',
sidebarId: 'community',
docsPluginId: 'community',
position: 'left',
label: 'Community',
},
{
href: 'https://blog.bacalhau.org/',
label: 'Blog',
position: 'right',
},
{
href: 'https://github.com/bacalhau-project/bacalhau',
position: 'right',
className: 'header-github-link',
'aria-label': 'GitHub repository',
},
],
},
footer: {
links: [
{
title: 'Learn',
items: [
{
label: 'What is Bacalhau?',
to: '/docs/',
},
{
label: 'Architecture',
to: '/docs/overview/architecture',
},
{
label: 'Quick Start',
to: '/docs/getting-started/quick-start',
},
],
},
{
title: 'Use Cases',
items: [
{
label: 'Log Processing',
to: 'use-cases/log-processing',
},
{
label: 'Distributed Data Warehousing',
to: 'use-cases/distributed-data-warehousing',
},
{
label: 'Distributed Machine Learning',
to: 'use-cases/distributed-machine-learning',
},
{
label: 'Edge Computing',
to: 'use-cases/edge-computing',
},
{
label: 'Fleet Management',
to: 'use-cases/fleet-management',
},
],
},
{
title: 'Community & Social',
items: [
{
label: 'GitHub',
href: 'https://github.com/bacalhau-project/bacalhau',
},
{
label: 'Slack',
href: 'https://bit.ly/bacalhau-project-slack',
},
{
label: 'Twitter/X',
href: 'https://twitter.com/BacalhauProject',
},
{
label: 'LinkedIn',
href: 'https://www.linkedin.com/showcase/bacalhau-project/posts',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Bacalhau Project.`,
},
prism: {
additionalLanguages: ['bash'],
},
} satisfies Preset.ThemeConfig,
}
export default config