-
Notifications
You must be signed in to change notification settings - Fork 16
/
docusaurus.config.js
177 lines (163 loc) · 5.81 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
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
//const lightCodeTheme = require('prism-react-renderer/themes/github');
const lightCodeTheme = require('prism-react-renderer').themes.github;
//const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const darkCodeTheme = require('prism-react-renderer').themes.dracula;
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Zoned Storage',
tagline: 'Zoned Storage is an open source, standards-based initiative to enable data centers to scale efficiently for the zettabyte storage capacity era. There are two technologies behind Zoned Storage, Shingled Magnetic Recording (SMR) in ATA/SCSI HDDs and Zoned Namespaces (ZNS) in NVMe SSDs.',
organizationName: 'westerndigitalcorporation',
projectName: 'zonedstorage.io',
url: 'https://zonedstorage.io',
baseUrl: '/',
trailingSlash: false,
favicon: 'img/zs-logo.ico',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
plugins: [
/**
* Google analytics plugin is already included with preset-classic
* so we do not need to add it explicitly.
* ['@docusaurus/plugin-google-analytics'],
*/
['@docusaurus/plugin-google-gtag',
{
trackingID: 'G-0DX1KGD5E4',
}
],
[require.resolve('@cmfcmf/docusaurus-search-local'), {
/** whether to index docs pages */
indexDocs: true,
/**
* Whether to also index the titles of the parent categories in the
* sidebar of a doc page:
* 0 disables this feature.
* 1 indexes the direct parent category in the sidebar of a doc page
* 2 indexes up to two nested parent categories of a doc page
* 3...
*
* Do _not_ use Infinity, the value must be a JSON-serializable integer.
*/
indexDocSidebarParentCategories: 0,
/** whether to index blog pages */
indexBlog: false,
/** blogRouteBasePath: '/blog', */
/** whether to index static pages (/404.html is never indexed) */
indexPages: false,
/**
* Setting this to "none" will prevent the default CSS to be included. The default CSS
* comes from autocomplete-theme-classic, which you can read more about here:
* https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-theme-classic/
*/
style: undefined,
/** lunr.js-specific settings */
lunr: {
/**
* When indexing your documents, their content is split into "tokens".
* Text entered into the search box is also tokenized. This setting
* configures the separator used to determine where to split the text into
* tokens. By default, it splits the text at whitespace and dashes.
* Note: Does not work for "ja" and "th" languages, since these use a
* different tokenizer.
*/
tokenizerSeparator: /[\s\-]+/
}
}]
],
presets: [
[
'@docusaurus/preset-classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve('./src/components/sidebars.js'),
/** editUrl: 'https://github.com/westerndigitalcorporation/zonedstorage.io/edit/main/website/', */
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
hideOnScroll: false,
title: 'Zoned Storage',
logo: {
alt: 'Zoned Storage Logo',
src: 'img/zs-logo.png',
},
items: [
{
label: 'Documentation',
position: 'left',
type: 'doc',
docId: 'introduction/index',
},
{
label: 'Community',
position: 'left',
to: '/docs/community/support',
},
{
label: 'GitHub',
position: 'right',
href: 'https://github.com/westerndigitalcorporation/zonedstorage.io',
className: 'header-github-link',
'aria-label': 'GitHub repository',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Introduction to Zoned Storage',
to: '/docs/introduction/zoned-storage',
},
{
label: 'Getting Started with Zoned Storage',
to: '/docs/getting-started/',
},
],
},
{
title: 'Community',
items: [
{
label: 'Matrix',
href: 'https://app.element.io/#/room/#zonedstorage-general:matrix.org',
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub Organization',
href: 'https://github.com/westerndigitalcorporation',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Western Digital
Corporation or its affiliates. All rights reserved.<br> By using this site, you agree to the <a href="https://www.westerndigital.com/legal/terms-of-use" target="_blank">Terms of Use</a> and <a href="https://www.westerndigital.com/legal/privacy-statement" target="_blank">Privacy Statement</a>. All example scripts and program snippets on this site are licensed under the <a href="https://creativecommons.org/publicdomain/zero/1.0/" target="_blank">CCO 1.0 Universal</a> license.<br>This site is built with <a href="https://docusaurus.io/" target="_blank">Docusaurus</a>.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
};
module.exports = config;