-
-
Notifications
You must be signed in to change notification settings - Fork 63
Expand file tree
/
Copy pathdocusaurus.config.ts
More file actions
333 lines (319 loc) · 8.91 KB
/
docusaurus.config.ts
File metadata and controls
333 lines (319 loc) · 8.91 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
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
const config: Config = {
title: "Bluefin",
tagline: "Bluefin Documentation",
favicon: "img/logo.svg",
url: "https://docs.projectbluefin.io",
baseUrl: "/",
trailingSlash: true,
future: {
experimental_faster: true,
v4: {
removeLegacyPostBuildHeadAttribute: true,
},
},
// GitHub pages deployment config.
organizationName: "ublue-os",
projectName: "bluefin",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
i18n: {
defaultLocale: "en",
locales: ["en"],
},
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
presets: [
[
"classic",
{
docs: {
sidebarPath: "./sidebars.ts",
// Disables the landing page
routeBasePath: "/",
editUrl: "https://github.com/projectbluefin/documentation/tree/main",
},
blog: {
blogTitle: "Bluefin's Blog",
blogDescription: "Official Blog and Announcements",
blogSidebarCount: "ALL",
blogSidebarTitle: "Raptor News",
editUrl: "https://github.com/projectbluefin/documentation/edit/main/",
authorsMapPath: "authors.yaml",
truncateMarker: /(?!.*)/,
feedOptions: {
type: ["rss", "atom"],
xslt: true,
title: "Bluefin Blog",
description: "Official Blog and Announcements",
},
},
theme: {
customCss: "./src/css/custom.css",
},
} satisfies Preset.Options,
],
],
plugins: [
[
"@1password/docusaurus-plugin-stored-data",
{
data: {
bluefinReleases: "https://github.com/ublue-os/bluefin/releases.atom",
bluefinLtsReleases:
"https://github.com/ublue-os/bluefin-lts/releases.atom",
bluefinDiscussions:
"https://github.com/ublue-os/bluefin/discussions.atom",
bluefinAnnouncements:
"https://github.com/ublue-os/bluefin/discussions.atom?discussions_q=is%3Aopen+label%3Aannouncements",
},
},
],
[
"@easyops-cn/docusaurus-search-local",
{
hashed: true,
docsRouteBasePath: "/",
indexBlog: true,
indexDocs: true,
},
],
[
"@docusaurus/plugin-content-blog",
{
id: "reports",
routeBasePath: "reports",
path: "./reports",
blogTitle: "Monthly Reports",
blogDescription:
"Automated project activity reports from GitHub Project Board",
blogSidebarTitle: "Recent Reports",
blogSidebarCount: 10,
postsPerPage: 20,
showReadingTime: false, // System-generated content
authorsMapPath: "authors.yaml",
feedOptions: {
type: "all",
title: "Project Bluefin - Monthly Reports",
description: "Automated monthly activity reports from project board",
copyright: `Copyright © ${new Date().getFullYear()} Project Bluefin`,
},
// Enable table of contents in right sidebar
blogPostComponent: "@theme/BlogPostPage",
showLastUpdateTime: false,
},
],
],
themeConfig: {
docs: {
sidebar: {
hideable: false,
},
},
announcementBar: {
id: "announcement",
content:
'Reminder: Bluefin GTS has been merged into mainline Bluefin. Check the <a href="https://docs.projectbluefin.io/blog/bluefin-2025/">State of the Raptor</a> for more information.',
backgroundColor: "#fafbfc",
textColor: "#091E42",
isCloseable: true,
},
metadata: [
{
name: "keywords",
content:
"documentation, bluefin, universalblue, linux, gnome, podman, docker, cloudnative",
},
{ name: "twitter:card", content: "summary_large_image" },
],
// Social card that shows up on discord when you share it
image: "img/meta.png",
navbar: {
title: "Bluefin",
logo: {
alt: "Bluefin",
src: "img/logo.svg",
href: "https://projectbluefin.io",
},
items: [
{
type: "docSidebar",
sidebarId: "baseSidebar",
position: "left",
label: "Documentation",
},
{
href: "https://ask.projectbluefin.io",
label: "Ask Bluefin",
position: "left",
},
{
to: "blog",
label: "Blog",
position: "right",
},
{
to: "changelogs",
label: "Changelogs",
position: "right",
},
{
to: "reports",
label: "Reports",
position: "right",
},
{
href: "https://github.com/ublue-os/bluefin/discussions",
label: "Discussions",
position: "right",
},
{
href: "https://feedback.projectbluefin.io/",
label: "Feedback",
position: "right",
},
{
href: "https://store.projectbluefin.io",
label: "Store (US Only)",
position: "right",
},
],
},
footer: {
style: "dark",
links: [
{
title: "Universal Blue",
items: [
{
label: "Aurora",
href: "https://getaurora.dev",
},
{
label: "Bazzite",
href: "https://bazzite.gg/",
},
{
label: "uCore",
href: "https://github.com/ublue-os/ucore",
},
{
label: "Universal Blue",
href: "https://universal-blue.org",
},
],
},
{
title: "Community",
items: [
{
label: "Blog and Announcements",
href: "https://blog.projectbluefin.io/",
},
{
label: "Discussions",
href: "https://github.com/ublue-os/bluefin/discussions",
},
{
label: "Discord",
href: "https://discord.gg/XUC8cANVHy",
},
{
label: "Ask Bluefin",
href: "https://ask.projectbluefin.io",
},
{
label: "Feedback",
href: "https://feedback.projectbluefin.io/",
},
{
label: "Changelogs",
href: "https://changelogs.projectbluefin.io",
},
],
},
{
title: "RSS Feeds",
items: [
{
label: "Blog and Announcements Feed",
href: "https://docs.projectbluefin.io/blog/atom.xml",
},
{
label: "Releases Feed",
href: "https://github.com/ublue-os/bluefin/releases.atom",
},
{
label: "LTS Releases Feed",
href: "https://github.com/ublue-os/bluefin-lts/releases.atom",
},
{
label: "Discussions Feed",
href: "https://github.com/ublue-os/bluefin/discussions.atom",
},
],
},
{
title: "Contribute",
items: [
{
label: "Open Issues",
href: "https://issues.projectbluefin.io",
},
{
label: "Open Pull Requests",
href: "https://pullrequests.projectbluefin.io",
},
{
label: "Contributor's Guide",
href: "https://contribute.projectbluefin.io",
},
],
},
{
title: "GitHub",
items: [
{
label: "Main Bluefin Repository",
href: "https://github.com/projectbluefin",
},
{
label: "Bluefin",
href: "https://github.com/ublue-os/bluefin",
},
{
label: "Bluefin LTS",
href: "https://github.com/ublue-os/bluefin-lts",
},
{
label: "Documentation",
href: "https://github.com/projectbluefin/documentation",
},
{
label: "Website",
href: "https://github.com/projectbluefin/website",
},
{
label: "Report Issue",
href: "https://github.com/ublue-os/bluefin/issues/new/choose",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Project Bluefin and Universal Blue`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
colorMode: {
respectPrefersColorScheme: true,
},
} satisfies Preset.ThemeConfig,
};
export default config;