forked from alibaba-open-source-website/easyexcel
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docusaurus.config.js
226 lines (217 loc) · 9.28 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
219
220
221
222
223
224
225
226
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
*/
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Easy Excel',
tagline: 'EasyExcel是一个基于Java的、快速、简洁、解决大文件内存溢出的Excel处理工具。他能让你在不用考虑性能、内存的等因素的情况下，快速完成Excel的读、写等功能。',
url: 'https://easyexcel.opensource.alibaba.com',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
organizationName: 'alibaba', // Usually your GitHub org/user name.
projectName: 'easyexcel', // Usually your repo name.
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// 这里写自己的文档编辑地址
editUrl: 'https://github.com/alibaba-open-source-website/easyexcel/tree/main/',
lastVersion: 'current',
versions: {
"current": {
label: "3.1.x-3.2.x",
path: "current",
},
"3.0.x": {
label: "3.0.x",
path: "3.0.x",
},
"2.x": {
label: "2.x",
path: "2.x",
},
}
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
// 设置谷歌数据分析
gtag: {
trackingID: 'G-CKCNEFWX6M',
anonymizeIP: true,
},
}),
],
],
plugins: [
[
// 这里新增一个 多个doc的插件 专门用来 管理 社区 可以参考：https://docusaurus.io/docs/docs-multi-instance
// 为什么不用docs一起？ 因为 社区 不需要版本管理
'@docusaurus/plugin-content-docs',
{
id: 'community',
path: 'community',
routeBasePath: 'community',
sidebarPath: require.resolve('./sidebarsCommunity.js'),
},
],
[
// 常见问题
'@docusaurus/plugin-content-docs',
{
id: 'qa',
path: 'qa',
routeBasePath: 'qa',
sidebarPath: require.resolve('./sidebarsQa.js'),
},
],
// 接入开源官网的流量统计
[
'docusaurus-plugin-includes',
{
injectedHtmlTags: {
headTags: [
{
tagName: 'meta',
attributes: {
name: 'aes-config',
content: 'pid=xux-opensource&user_type=101&uid=&username=&dim10=easyexcel',
},
},
],
preBodyTags: [
{
tagName: 'script',
attributes: {
src: '//g.alicdn.com/alilog/mlog/aplus_v2.js',
id: 'beacon-aplus',
exparams: 'clog=o&aplus&sidx=aplusSidx&ckx=aplusCkx',
async: true
},
},
{
tagName: 'script',
attributes: {
src: '//g.alicdn.com/aes/??tracker/1.0.34/index.js,tracker-plugin-pv/2.4.5/index.js,tracker-plugin-event/1.2.5/index.js,tracker-plugin-jserror/1.0.13/index.js,tracker-plugin-api/1.1.14/index.js,tracker-plugin-perf/1.1.8/index.js,tracker-plugin-eventTiming/1.0.4/index.js',
async: true
},
},
],
}
},
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
prism: {
// 这里设置 支持```java ``` 这种代码块的样式，详细文档参照： https://www.docusaurus.cn/docs/markdown-features/code-blocks
additionalLanguages: ['java'],
// 可以配置不同的代码块样式 参考：https://docusaurus.io/docs/markdown-features/code-blocks#supported-languages
// 可选项：https://github.com/FormidableLabs/prism-react-renderer/tree/master/src/themes
theme: require('prism-react-renderer/themes/github'),
darkTheme: require('prism-react-renderer/themes/oceanicNext'),
},
// 这里设置关键字 和描述 ，方便给搜索引擎收录 https://docusaurus.io/docs/seo#global-metadata
metadata: [
{
name: 'keywords',
content: 'easyexcel 官方,easyexcel官方文档,easyexcel,easyexcel官网,easy excel,esayexcel,easyexcle,easyexcal,easyexecl,eazyexcel,easyexcel文档,easy-excel,easyexcel official,Excel,Easy Excel,Java,xls,xlsx,csv,省内存,简单,读excel,写excel,解析Excel,poi,oom,OutOfMemoryError'
},
{
name: 'description',
content: 'EasyExcel是一个基于Java的、快速、简洁、解决大文件内存溢出的Excel处理工具。他能让你在不用考虑性能、内存的等因素的情况下，快速完成Excel的读、写等功能。'
},
],
// 最上面的广告位 https://docusaurus.io/docs/api/themes/configuration#announcement-bar
announcementBar: {
id: 'announcementBar-2',
content: '⭐ 开源不易，如果觉得本项目对您的工作还是有帮助的话， 请帮忙在<a target="_blank" rel="noopener noreferrer" href="https://github.com/alibaba/easyexcel">GitHub</a> 点个⭐️Star',
},
// 接入algolia搜索引擎
algolia: {
appId: 'F6HGNCPO3I',
apiKey: 'ebcbf48764c1c5385aebc9855fbf5fdd',
indexName: 'easyexcel',
},
navbar: {
// 设置标题
title: 'Easy Excel',
// 设置导航条的log
logo: {
alt: 'Easy Excel',
src: 'img/logo.png',
href: 'https://easyexcel.opensource.alibaba.com',
target: '_self',
},
items: [
// 设置文档菜单 以及索引
{
type: 'doc',
docId: 'index',
position: 'right',
label: '文档',
},
{
type: 'doc',
docId: 'api/index',
position: 'right',
label: 'API',
},
{
label: '常见问题',
type: 'doc',
docId: 'index',
position: 'right',
docsPluginId: 'qa',
},
{
label: '社区',
type: 'doc',
docId: 'support',
position: 'right',
docsPluginId: 'community',
},
{
type: 'docsVersionDropdown',
position: 'right',
dropdownActiveClassDisabled: true
},
{
href: 'https://github.com/alibaba/easyexcel',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
logo: {
alt: 'Alibaba Open Source Logo',
src: 'img/opensource_logo.png',
href: 'https://opensource.alibaba.com',
},
// Please do not remove the credits, help to publicize Docusaurus :)
copyright: `Copyright © ${new Date().getFullYear()} Alibaba, Inc. Built with Docusaurus. 备案号：浙B2-20120091-4`,
},
}),
// 国际化
// 这里设置默认为中文 ，不设置的话默认为英文，可能部分展示出来是英文
// 真正要做国际化参考： https://docusaurus.io/docs/i18n/git 这里注意执行一个命令就行了，不需要自己一个个的创建文件
i18n: {
defaultLocale: 'zh',
locales: ['zh'],
},
};
module.exports = config;