-
Notifications
You must be signed in to change notification settings - Fork 1
/
docusaurus.config.ts
270 lines (255 loc) · 7.45 KB
/
docusaurus.config.ts
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
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: '203 Systems',
favicon: 'img/favicon.png',
// Set the production url of your site here
url: 'https://matrix.203.io',
// 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: '203-Systems', // Usually your GitHub org/user name.
projectName: 'Matrix-Wiki', // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: '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', 'zh-Hans'],
},
presets: [
[
'classic',
{
docs: {
sidebarPath: './sidebars.ts',
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/203-Systems/Matrix-Wiki/tree/master/',
versions: {
current: {
label: 'Canary 🚧',
},
},
},
blog: {
showReadingTime: true,
feedOptions: {
type: ['rss', 'atom'],
xslt: true,
},
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/203-Systems/Matrix-Wiki/tree/main/',
// Useful options to enforce blogging best practices
onInlineTags: 'warn',
onInlineAuthors: 'warn',
onUntruncatedBlogPosts: 'warn',
},
theme: {
customCss: './src/css/custom.css',
},
googleTagManager: {
containerId: 'GTM-5B334X6T',
},
sitemap: {
lastmod: 'date',
changefreq: 'weekly',
priority: 0.5,
ignorePatterns: ['/tags/**'],
filename: 'sitemap.xml',
createSitemapItems: async (params) => {
const {defaultCreateSitemapItems, ...rest} = params;
const items = await defaultCreateSitemapItems(rest);
return items.filter((item) => !item.url.includes('/page/'));
},
},
} satisfies Preset.Options,
],
],
themeConfig: {
docs: {
versionPersistence: 'localStorage',
sidebar: {
hideable: true,
autoCollapseCategories: false,
},
},
navbar: {
// title: '203 Systems',
logo: {
alt: '203 Systems',
src: 'img/203.svg',
srcDark: 'img/203dark.svg',
},
items: [
{
type: 'docSidebar',
sidebarId: 'mystrixSidebar',
position: 'left',
label: 'Mystrix',
},
{
type: 'docSidebar',
sidebarId: 'matrixOSSidebar',
position: 'left',
label: 'Matrix OS',
},
{
type: 'docSidebar',
sidebarId: 'developerSidebar',
position: 'left',
label: 'Developer',
},
{
type: 'docSidebar',
sidebarId: 'resourcesSidebar',
position: 'left',
label: 'Resources',
},
{
type: 'docSidebar',
sidebarId: 'supportSidebar',
position: 'left',
label: 'Support',
},
// {to: '/blog', label: 'Updates', position: 'left'},
{
type: 'docsVersionDropdown',
position: 'right',
},
// Disable Chinese for now
// {
// type: 'localeDropdown',
// position: 'right',
// },
{
href: 'https://github.com/203-Systems',
position: 'right',
className: 'header-github-link',
'aria-label': 'GitHub repository',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Mystrix',
to: 'docs/Mystrix/GettingStarted',
},
{
label: 'Matrix OS',
to: 'docs/MatrixOS/MatrixOSBasics',
},
{
label: 'Developer',
to: 'docs/Developer/MatrixOSBasics',
},
{
label: 'Resources',
to: 'docs/Resources/MystrixHardwareDesigns'
},
{
label: 'Support',
to: 'docs/Support/ConnectWithUs'
},
{
label: 'Backroom',
to: 'docs/Backroom'
}
],
},
{
title: 'Community',
items: [
{
label: 'Discord',
href: 'https://discord.gg/rRVCBHHPfw',
},
{
label: 'Twitter / X',
href: 'https://twitter.com/203Systems',
},
{
label: 'Instagram',
href: 'https://instagram.com/203null',
},
{
label: 'Youtube',
href: 'https://www.youtube.com/channel/UCl9tL-r4NzvGl-EIeVYZZ-g',
},
{
label: 'Facebook',
href: 'https://facebook.com/203Systems',
}
],
},
{
title: 'More',
items: [
{
label: '203 Systems',
to: 'https://203.io',
},
{
label: 'GitHub',
href: 'https://github.com/203-Systems',
},
],
},
],
logo: {
alt: '203 Systems',
src: 'img/203 systems long dark.svg',
href: 'https://203.io',
target: '_self',
style: {
maxWidth: 300,
},
},
copyright: `Copyright © ${new Date().getFullYear()} 203 Systems`,
},
announcementBar: {
id: 'under-development',
content: `<b>🚧 Project Matrix Wiki is currently in development. Contents may be incorrect, incomplete, or outdated. 🚧</b>`,
},
image: 'img/social-card.jpg',
algolia: {
// The application ID provided by Algolia
appId: 'NX86NL0BFF',
// Public API key: it is safe to commit it
apiKey: '39f74a16abae5976cd799acc6a758192',
indexName: 'matrix-203',
// Optional: see doc section below
contextualSearch: true,
// Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
replaceSearchResultPathname: {
from: '/docs/', // or as RegExp: /\/docs\//
to: '/',
},
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',
// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: true,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.vsDark,
},
} satisfies Preset.ThemeConfig,
};
function getNextVersionName() {
return 'Canary';
}
export default config;