forked from coredao-org/CoreDAO-Docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocusaurus.config.ts
257 lines (235 loc) · 7.07 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
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import remarkMath from "remark-math";
import rehypeKatex from "rehype-katex";
import type * as Plugin from "@docusaurus/types/src/plugin";
import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs";
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
const DefaultLocale = "en";
const config: Config = {
title: "Core DAO Official Documentation",
favicon: "img/favicon.ico",
/// Set the production url of your site here
url: "https://docs.coredao.org/",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
// baseUrl: '/',
baseUrl: "/",
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "coredao-org", // Usually your GitHub org/user name.
projectName: "CoreDAO-Docs", // Usually your repo name.
deploymentBranch: "main",
trailingSlash: false,
onBrokenLinks: "warn",
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", "fr", "es"],
},
staticDirectories: ["public", "static"],
presets: [
[
"@docusaurus/preset-classic",
{
docs: {
sidebarPath: "./sidebars.ts",
// Remove this to remove the "edit this page" links.
// editUrl: 'https://github.com/coredao-org/CoreDAO-Docs/blob/main',
editUrl: ({ locale, versionDocsDirPath, docPath }) => {
// Link to Crowdin for French docs
if (locale !== DefaultLocale) {
return `https://github.com/coredao-org/CoreDAO-Docs/blob/main`;
}
// Link to GitHub for English docs
return `https://github.com/coredao-org/CoreDAO-Docs/blob/main`;
},
routeBasePath: "docs",
path: "docs",
remarkPlugins: [remarkMath],
rehypePlugins: [rehypeKatex],
docItemComponent: "@theme/ApiItem", // Derived from docusaurus-theme-openapi
},
gtag: {
trackingID: "G-F20V7Q57RZ",
anonymizeIP: true,
},
theme: {
customCss: "./src/css/custom.css",
},
} satisfies Preset.Options,
],
],
plugins: [
[
"docusaurus-plugin-openapi-docs",
{
id: "api", // plugin id
docsPluginId: "classic", // configured for preset-classic
config: {
stakingapimainnet: {
specPath: "docs/stakingAPI/swagger/mainnet.yaml",
outputDir: "docs/stakingAPI/mainnet",
sidebarOptions: {
groupPathsBy: "tag",
},
} satisfies OpenApiPlugin.Options,
stakingapitestnet: {
specPath: "docs/stakingAPI/swagger/testnet.yaml",
outputDir: "docs/stakingAPI/testnet",
sidebarOptions: {
groupPathsBy: "tag",
},
} satisfies OpenApiPlugin.Options,
},
},
],
],
themes: ["docusaurus-theme-openapi-docs"], // export theme components
stylesheets: [
{
href: "https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css",
type: "text/css",
integrity:
"sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM",
crossorigin: "anonymous",
},
],
themeConfig: {
// Replace with your project's social card
image: "img/core.png",
//Color Scheme Preferrence
colorMode: {
defaultMode: "dark",
disableSwitch: false,
respectPrefersColorScheme: false,
},
//Announcement Bar
announcementBar: {
id: "latest_updates",
content:
'⚠️ <a target="_blank" rel="noopener noreferrer" href="https://medium.com/@core_dao/lstbtc-is-coming-sunsetting-corebtc-486d6744c3b9">LstBTC Launching Soon!</a> coreBTC is sunsetting — redeem your assets now to secure your holdings. ⚠️',
backgroundColor: "#f96e34",
textColor: "#FBFCFC",
isCloseable: false,
},
//Algolia Search Setting
algolia: {
// The application ID provided by Algolia
appId: "FA8VWNN4PE",
// Public API key: it is safe to commit it
apiKey: "918f3b86baa18924ad7436755ade2427",
indexName: "coredao",
},
//Header Navigation Items
navbar: {
title: "Core DAO",
logo: {
alt: "Core DAO Logo",
src: "img/core.png",
href: "/docs/intro",
},
items: [
{
type: "docSidebar",
sidebarId: "learnSidebar",
position: "left",
label: "Learn",
activeBaseRegex: `/docs/`,
},
{
type: "docSidebar",
sidebarId: "devGuideSidebar",
position: "left",
label: "Build",
activeBaseRegex: `/docs/`,
},
{
type: "docSidebar",
sidebarId: "nodeSidebar",
position: "left",
label: "Run a Node",
activeBaseRegex: `/docs/`,
},
{
type: "docSidebar",
sidebarId: "stakeDelegateSidebar",
position: "left",
label: "Stake & Delegate",
activeBaseRegex: `/docs/`,
},
{
type: "docSidebar",
sidebarId: "apiSidebar",
position: "left",
label: "API",
activeBaseRegex: `/docs/`,
},
{
type: "docSidebar",
sidebarId: "faqSidebar",
position: "left",
label: "FAQs",
activeBaseRegex: `/docs/`,
},
{
type: "localeDropdown",
position: "right",
},
{
href: "https://github.com/coredao-org",
label: "GitHub",
position: "right",
},
{
href: "https://coredao.org/explore/blog",
label: "Blog",
position: "right",
},
],
},
footer: {
style: "dark",
links: [
{
label: "Core DAO",
href: "https://coredao.org/",
},
{
label: "Docs",
to: "/docs/intro",
},
{
label: "Explorer",
href: "https://scan.coredao.org/",
},
{
label: "Blog",
href: "https://coredao.org/explore/blog",
},
{
label: "Discord",
href: "https://discord.com/invite/coredaoofficial",
},
{
label: "X (formerly Twitter)",
href: "https://twitter.com/Coredao_Org",
},
{
label: "Telegram",
href: "https://t.me/CoreDAOTelegram",
},
],
copyright: `Copyright © ${new Date().getFullYear()} Core DAO`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
} satisfies Preset.ThemeConfig,
};
export default config;