-
Notifications
You must be signed in to change notification settings - Fork 63
/
docusaurus.config.js
218 lines (208 loc) · 8.6 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
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require("prism-react-renderer").themes.github;
const darkCodeTheme = require("prism-react-renderer").themes.dracula;
const TwitterSvg =
'<svg style="fill: #000000; vertical-align: middle; margin-left: 3px;" width="16" height="16" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8L200.7 275.5 26.8 48H172.4L272.9 180.9 389.2 48zM364.4 421.8h39.1L151.1 88h-42L364.4 421.8z"/></svg>';
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "OCI Registry As Storage",
favicon: "img/favicon.ico",
// Set the production url of your site here
url: "https://oras.land",
// 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: "oras-project", // Usually your GitHub org/user name.
projectName: "docusaurus", // Usually your repo name.
onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
// Even if you don't use internalization, 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"],
},
presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
"https://github.com/oras-project/oras-www/tree/main/",
includeCurrentVersion: false,
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
"https://github.com/oras-project/oras-www/tree/main/",
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
}),
],
],
plugins: [
[
'content-docs',
/** @type {import('@docusaurus/plugin-content-docs').Options} */
{
id: 'community',
path: 'community',
routeBasePath: 'community',
sidebarPath: require.resolve("./community/sidebars.js"),
editCurrentVersion: true,
showLastUpdateAuthor: true,
showLastUpdateTime: true,
},
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
algolia: {
appId: "KXO9RCDQGX",
apiKey: "6f21a78a8681d337c3b93995f3291e08",
indexName: "oras",
contextualSearch: true,
},
announcementBar: {
id: "announcement_bar",
content: `⭐ If you like ORAS Project, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/oras-project/oras">GitHub</a> and follow us on <a target="_blank" rel="noopener noreferrer" href="https://x.com/orasproject">${TwitterSvg}</a>`,
backgroundColor: "var(--theme-card)",
textColor: "var(--ifm-color-primary)",
isCloseable: true,
},
image: "img/oras_social_card.png",
navbar: {
logo: {
alt: "ORAS Logo",
src: "img/oras.svg",
},
items: [
{
type: "doc",
docId: "index",
position: "left",
label: "Docs",
},
{
to: '/community/community_resources',
label: 'Community',
position: 'left',
activeBaseRegex: `/community/`,
},
{
label: "Adopters",
to: "/adopters",
},
{ to: "/blog", label: "Blog", position: "left" },
{
type: "docsVersionDropdown",
position: "right",
dropdownActiveClassDisabled: true,
},
{
to: "https://cloud-native.slack.com/archives/CJ1KHJM5Z",
target: "_blank",
'aria-label': 'Slack',
className: 'navbar__icon navbar__slack',
position: "right",
html: '<i class="fab fa-sm fa-slack"></i>',
},
{
href: "https://github.com/oras-project",
target: "_blank",
'aria-label': 'GitHub',
className: 'navbar__icon navbar__github',
position: 'right',
html: '<i class="fab fa-sm fa-github"></i>',
},
{
href: "https://x.com/orasproject",
target: "_blank",
'aria-label': 'Twitter',
className: 'navbar__icon navbar__twitter',
position: "right",
html: '<i class="fab fa-sm fa-x-twitter"></i>',
},
],
},
footer: {
style: "dark",
links: [
{
title: "Docs",
items: [
{
label: "Introduction",
to: "/docs/",
},
{
label: "Installation",
to: "/docs/installation",
},
{
label: "How-to Guides",
to: "/docs/how_to_guides/authentication",
},
{
label: "ORAS Commands",
to: "/docs/commands/use_oras_cli",
},
{
label: "Client Libraries",
to: "/docs/client_libraries/overview",
},
],
},
{
title: "Community",
items: [
{
label: "GitHub",
href: "https://github.com/oras-project",
},
{
label: "Slack",
href: "https://cloud-native.slack.com/archives/CJ1KHJM5Z",
},
{
label: "X",
href: "https://x.com/orasproject",
},
],
},
{
title: "More",
items: [
{
label: "Blog",
to: "/blog",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} The Linux Foundation. All rights reserved.<br>The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/legal/trademark-usage">Trademark Usage page</a>.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
};
module.exports = config;