-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathdocusaurus.config.js
More file actions
239 lines (218 loc) · 7.31 KB
/
docusaurus.config.js
File metadata and controls
239 lines (218 loc) · 7.31 KB
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
// @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');
import { themes } from 'prism-react-renderer';
const defaultExclude = ['**/_*.{js,jsx,ts,tsx,md,mdx}', '**/_*/**', '**/*.test.{js,jsx,ts,tsx}', '**/__tests__/**'];
// some docs are not translated, so we need to exclude them in en
const excludeInEn = [];
/** @type {import('@docusaurus/types').Config} */
const config = {
future: {
v4: true,
faster: true,
},
title: 'coScene',
staticDirectories: ['public', 'static'],
tagline: 'User Docs',
url: 'https://docs.coscene.cn',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenAnchors: 'throw',
onDuplicateRoutes: 'throw',
favicon: 'img/favicon.ico',
markdown: {
mermaid: true,
mdx1Compat: {
comments: true,
admonitions: true,
headingIds: true,
},
hooks: {
onBrokenMarkdownLinks: 'throw',
},
},
themes: ['@docusaurus/theme-mermaid'],
i18n: {
defaultLocale: 'zh',
locales: ['zh', 'en'],
},
scripts: [{ src: 'https://plausible.io/js/script.js', defer: true, 'data-domain': 'docs.coscene.cn' }],
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'coScene', // Usually your GitHub org/user name.
projectName: 'docs', // Usually your repo name.
plugins: [require.resolve('./tailwind.plugin.js')],
presets: [
[
'classic',
{
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/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
showLastUpdateAuthor: true,
showLastUpdateTime: true,
exclude:
process.env.DOCUSAURUS_CURRENT_LOCALE === 'en' ? [...defaultExclude, ...excludeInEn] : defaultExclude,
},
blog: false,
// blog: {
// showReadingTime: true,
// // Please change this to your repo.
// // Remove this to remove the "edit this page" links.
// // editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
// },
theme: {
customCss: './src/css/custom.css',
},
},
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
title: 'coScene',
logo: {
alt: 'coScene Logo',
src: 'img/logo.svg',
width: '135px',
},
items: [
{
type: 'doc',
docId: 'overview',
position: 'left',
label: '文档',
},
{ to: '/changelog', label: '更新历史', position: 'left' },
{ type: 'localeDropdown', position: 'right' },
{ href: 'https://www.coscene.cn', label: '官方网站', position: 'right' },
{ href: 'https://github.com/coscene-io', label: 'GitHub', position: 'right' },
{
href: 'https://petstore.swagger.io/?url=https://download.coscene.cn/openapi/openapi.yaml',
label: 'OpenAPI',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
// {
// title: 'Docs',
// items: [
// {
// label: 'Docs',
// to: '/docs/intro',
// },
// ],
// },
// {
// title: 'Community',
// items: [
// {
// label: 'Stack Overflow',
// href: 'https://stackoverflow.com/questions/tagged/docusaurus',
// },
// ],
// },
{
title: '法律协议',
items: [
{
label: '隐私政策',
href: '/legal/privacy',
target: '_blank',
},
{
label: '服务协议',
href: '/legal/terms',
target: '_blank',
},
],
},
{
title: '数据安全',
items: [
{
label: '刻行数据安全白皮书',
href: '/security/security-white-paper',
target: '_blank',
},
{
label: '刻行数据安全方案',
href: '/security/data-security-solution',
target: '_blank',
},
],
},
{
title: '更多相关链接',
items: [
// {
// label: 'Blog',
// to: '/blog',
// },
{
label: 'GitHub',
href: 'https://github.com/coscene-io',
},
{
label: '刻行时空官网',
href: 'https://www.coscene.cn',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} coScene`,
},
prism: {
theme: themes.oceanicNext,
darkTheme: themes.dracula,
},
docs: {
sidebar: {
autoCollapseCategories: true,
},
},
algolia: {
appId: process.env.ALGOLIA_APP_ID || '1TFD6DKASB',
apiKey: process.env.ALGOLIA_API_KEY || '6340803417c38ec67854ac4ae37c55ce',
indexName: process.env.ALGOLIA_INDEX_NAME || 'coscene',
// 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: 'external\\.com|domain\\.com',
// Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
// replaceSearchResultPathname: {
// from: '/docs/', // or as RegExp: /\/docs\//
// to: '/',
// },
// Optional: Algolia search parameters
searchParameters: {},
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',
// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,
//... other Algolia params
},
// 只在开发环境中显示公告栏
...(process.env.DEPLOY_ENV === 'development' && {
announcementBar: {
id: 'dev_environment',
content: '⚠️ 这是开发环境版本 / This is Development Environment Version ⚠️',
backgroundColor: '#fafbfc',
textColor: '#091E42',
isCloseable: false,
},
}),
}),
customFields: {
// Add custom field to identify environment
isDevEnvironment: process.env.NODE_ENV !== 'production',
},
};
export default config;