forked from toshitehdev/greenfield-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docusaurus.config.js
158 lines (146 loc) · 4.48 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
// @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");
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "BNB Greenfield",
tagline: "Decentralized Data Storage and Economy",
url: "https://docs.bnbchain.org",
baseUrl: "/greenfield-docs/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon.ico",
trailingSlash: true,
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "bnb-chain", // Usually your GitHub org/user name.
projectName: "greenfield-docs", // Usually your repo name.
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/bnb-chain/greenfield-docs/blob/main/",
docLayoutComponent: "@theme/DocPage",
docItemComponent: "@theme/ApiItem" // Derived from docusaurus-theme-openapi
},
blog: {
showReadingTime: true,
editUrl: "https://github.com/bnb-chain/greenfield-docs/blob/main/",
},
theme: {
customCss: require.resolve("./src/css/custom.css")
},
gtag: {
trackingID: 'G-LSRFL0KHRR',
anonymizeIP: true,
},
sitemap: {
changefreq: 'weekly',
priority: 0.5,
ignorePatterns: ['/tags/**'],
filename: 'sitemap.xml',
}
})
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
(
{
metadata: [
{name: 'keywords', content: 'decentralized storage, blockchain storage solution'},
],
docs: {
sidebar: {
hideable: true
}
},
algolia: {
// The application ID provided by Algolia
appId: '3LF005YNGZ',
// Public API key: it is safe to commit it
apiKey: 'dbc11ec6638f9c767ef6ed2856871f58',
indexName: 'bnbchain',
// Optional: see doc section below
// contextualSearch: true,
// Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
externalUrlRegex: 'https://docs.bnbchain.org/',
},
navbar: {
title: "BNB Greenfield",
logo: {
alt: "Greenfield Logo",
src: "img/logo.svg"
},
items: [
{
label: "Guide",
position: "left",
to: "/docs/guide/introduction/overview"
},
{
label: "Tutorials",
position: "left",
to: "/docs/tutorials/overview"
},
{
//type: 'dropdown',
label: "API & SDK",
position: "left",
to: "/docs/api/endpoints",
},
{
label: "Releases",
position: "left",
to: "/docs/release-notes/releaseNotes"
},
{
label: "FAQs",
position: "left",
to: "/docs/faq/greenfield-faqs"
},
{
href: 'https://github.com/bnb-chain/greenfield-docs',
position: 'right',
className: 'header-github-link',
'aria-label': 'GitHub repository',
},
]
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ["ruby", "csharp", "php"]
}
}),
plugins: [
[
"docusaurus-plugin-openapi-docs",
{
id: "openapi",
docsPluginId: "classic",
config: {
greenfield: {
specPath: "swagger/greenfield-api.yaml",
outputDir: "docs/greenfield-api",
downloadUrl:
"https://raw.githubusercontent.com/bnb-chain/greenfield-docs/main/swagger/greenfield-api.yaml",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
}
}
}
]
],
themes: ["docusaurus-theme-openapi-docs"]
};
module.exports = config;