-
Notifications
You must be signed in to change notification settings - Fork 26
/
docusaurus.config.js
222 lines (207 loc) · 5.66 KB
/
docusaurus.config.js
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
// @ts-check
// `@type` JSDoc annotations allow editor autocompletion and type checking
// (when paired with `@ts-check`).
// There are various equivalent ways to declare your Docusaurus config.
// See: https://docusaurus.io/docs/api/docusaurus-config
import {themes as prismThemes} from 'prism-react-renderer';
const __webpack_public_path__ = "/docs/";
const resolveGlob = require("resolve-glob");
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "vcluster docs | Virtual Clusters for Kubernetes",
tagline: "Virtual Clusters for Kubernetes",
url: "https://vcluster.com",
baseUrl: __webpack_public_path__,
favicon: "/media/vcluster_symbol.svg",
organizationName: "loft-sh", // Usually your GitHub org/user name.
projectName: "vcluster-docs", // 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'],
},
themes: ["@saucelabs/theme-github-codeblock", "@docusaurus/theme-mermaid"],
markdown: {
mermaid: true,
},
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
path: "docs",
routeBasePath: "/",
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/loft-sh/vcluster-docs/edit/main/",
lastVersion: "current",
versions: {
current: {
label: "v0.20",
banner: "none",
badge: false,
},
},
},
theme: {
customCss: resolveGlob.sync(["./src/css/**/*.scss"]),
},
}),
],
[
"redocusaurus",
{
specs: [
{
spec: "schemas/config-openapi.json",
},
],
theme: {
primaryColor: "#00bdff",
redocOptions: {
hideDownloadButton: false,
disableSearch: true,
colors: {
border: {
dark: "#00bdff",
light: "#00bdff",
},
},
},
},
},
],
],
plugins: [
"docusaurus-plugin-sass",
"plugin-image-zoom",
[
'@docusaurus/plugin-content-docs',
{
id: 'vcluster',
path: 'vcluster',
routeBasePath: 'vcluster',
sidebarPath: require.resolve('./sidebarsVCluster.js'),
lastVersion: "0.20.0",
versions: {
current: {
label: "main 🚧",
},
"0.20.0": {
label: "v0.20 Stable",
banner: "none",
badge: false,
}
},
},
],
[
'@docusaurus/plugin-content-docs',
{
id: 'platform',
path: 'platform',
routeBasePath: 'platform',
sidebarPath: require.resolve('./sidebarsPlatform.js'),
lastVersion: "current",
versions: {
current: {
label: "v4.0 Stable",
banner: "none",
badge: false,
},
},
// ... other options
},
],
],
scripts: [
{
src: "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
async: true,
},
{
src: "/docs/js/custom.js",
async: true,
},
],
clientModules: resolveGlob.sync(["./src/js/**/*.js"]),
themeConfig: (
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
{
mermaid: {
theme: {light: 'default', dark: 'dark'},
},
tableOfContents: {
// default is ##, ### so add ####
minHeadingLevel: 2,
maxHeadingLevel: 4,
},
colorMode: {
defaultMode: "light",
disableSwitch: true,
respectPrefersColorScheme: false,
},
navbar: {
logo: {
alt: "vcluster",
src: "/media/vCluster_horizontal-orange.svg",
href: "https://vcluster.com/docs",
target: "_self",
},
items: [
{
href: "https://vcluster.com/",
label: "Website",
position: "right",
target: "_self",
},
{
href: "https://loft.sh/blog",
label: "Blog",
position: "right",
target: "_self",
},
{
href: "https://slack.loft.sh/",
className: "slack-link",
"aria-label": "Slack",
position: "right",
},
{
href: "https://github.com/loft-sh/vcluster",
className: "github-link",
"aria-label": "GitHub",
position: "right",
},
],
},
algolia: {
appId: "K85RIQNFGF",
apiKey: "057a9f939df7215d92c8171d47352c54",
indexName: "vcluster",
placeholder: "Search...",
algoliaOptions: {},
},
footer: {
style: "light",
links: [],
copyright: `Copyright © ${new Date().getFullYear()} <a href="https://loft.sh/">Loft Labs, Inc.</a>`,
},
prism: {
theme: prismThemes.dracula,
additionalLanguages: ["bash", "hcl"],
},
announcementBar: {
id: 'platform-upgrade',
content: '🚀 <strong>Platform 4.0 is now available!</strong> Check out the <a href="/docs/platform/reference/migrations/4-0-migration">latest docs</a> and upgrade today!',
backgroundColor: '#4a90e2',
textColor: '#ffffff',
isCloseable: false,
},
}),
};
export default config;