forked from VRCFaceTracking/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docusaurus.config.js
226 lines (209 loc) · 6.45 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
// @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: 'VRCFaceTracking',
tagline: '"Trust me it\'s not even that hard"',
favicon: 'img/favicon.ico',
trailingSlash: false,
customFields: {
discord: {
label: "Discord",
href: "https://discord.gg/vrcft",
},
github: {
label: "GitHub",
href: "https://github.com/benaclejames/VRCFaceTracking",
},
},
// Set the production url of your site here
url: 'https://docs.vrcft.io',
// 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: 'VRCFaceTracking', // Usually your GitHub org/user name.
projectName: 'docs', // Usually your repo name.
onBrokenLinks: 'throw',
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/VRCFaceTracking/docs/edit/master',
lastVersion: 'current',
versions: {
current: {
label: 'Current (v5.0)',
path: '',
},
'v4.0': {
label: 'v4.0.0',
path: 'v4.0',
},
},
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
headTags: [
{
tagName: 'script',
attributes: {
type: 'application/ld+json',
},
innerHTML: JSON.stringify({
'@context': 'https://schema.org/',
'@type': 'WebSite',
name: 'VRCFaceTracking Docs',
url: 'https://docs.vrcft.io/'
}),
},
],
colorMode: {
defaultMode: 'dark',
respectPrefersColorScheme: true,
},
// Replace with your project's social card
//image: 'img/docusaurus-social-card.jpg',
docs: {
sidebar: {
hideable: true,
}
},
navbar: {
title: 'VRCFaceTracking',
logo: {
alt: 'VRCFaceTracking Logo',
src: 'img/logo.svg',
},
items: [
{
type: 'docsVersionDropdown',
},
// {
// type: 'doc',
// docId: 'intro',
// position: 'left',
// label: 'Intro',
// },
{
type: 'doc',
docId: 'intro/getting-started',
position: 'left',
label: 'Getting Started'
},
{
type: 'doc',
docId: '/category/avatar-setup',
position: 'left',
label: 'Avatar Setup'
},
{
type: 'search',
position: 'right',
},
{
href: 'https://discord.com/invite/vrcft',
position: 'right',
className: 'header-discord-link',
'aria-label': 'Discord',
},
{
href: 'https://github.com/benaclejames/VRCFaceTracking',
position: 'right',
className: 'header-github-link',
'aria-label': 'GitHub',
},
// {
// type: 'html',
// position: 'right',
// value: '<div style="margin:auto auto; display: flex; justify-content: center; height: 24px"><p> | </p></div>'
// }
],
},
algolia: {
// The application ID provided by Algolia
appId: 'IG7PS0550Z',
// Public API key: it is safe to commit it
apiKey: 'ff142e454687ae4be29e2a6080754a7f',
indexName: 'vrcft',
// 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: Algolia search parameters
searchParameters: {},
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Getting Started',
to: '/docs/intro/getting-started',
},
],
},
{
title: 'Community',
items: [
{
label: 'Discord',
href: 'https://discord.com/invite/vrcft',
},
{
label: 'Twitter',
href: 'https://twitter.com/benaclejames',
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://github.com/benaclejames/VRCFaceTracking',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} VRCFaceTracking. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
markdown: {
mermaid: true,
},
// themes: ['@docusaurus/theme-mermaid'],
};
module.exports = config;