/
nuxt.schema.ts
216 lines (216 loc) · 5.6 KB
/
nuxt.schema.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
export default defineNuxtConfigSchema({
appConfig: {
/**
* Docus theme configuration.
*
* @studio-icon material-symbols:docs
*/
docus: {
/**
* Website title, used as header default title and meta title.
*
* @studio-icon material-symbols:title
*/
title: 'Docus',
/**
* Website description, used for meta description.
*
* @studio-icon material-symbols:description
*/
description: 'The best place to start your documentation.',
/**
* Cover image.
*
* @example '/cover.jpg'
*
* @studio-icon dashicons:cover-image
*/
image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png',
/**
* Social links.
*
* Will be used in Social Icons component, in AppHeader and AppFooter.
*
* @studio-icon material-symbols:share-outline
*/
socials: {
/**
* Twitter social handle
* @example 'nuxt_js'
* @studio-icon simple-icons:twitter
*/
twitter: '',
/**
* GitHub org or repository
* @example 'nuxt/framework'
* @studio-icon simple-icons:github
*/
github: '',
/**
* Facebook page url
* @example https://www.facebook.com/groups/nuxtjs
* @studio-icon simple-icons:facebook
*/
facebook: '',
/**
* Instagram page url
* @example https://www.instagram.com/wearenuxt
* @studio-icon simple-icons:instagram
*/
instagram: '',
/**
* Instagram page url
* @example https://www.youtube.com/@NuxtLabs
* @studio-icon simple-icons:youtube
*/
youtube: '',
/**
* Medium page url
* @example https://medium.com/nuxt
* @studio-icon simple-icons:medium
*/
medium: ''
},
/**
* Theme layout configuration.
*
* @studio-icon tabler:arrow-autofit-width
*/
layout: {
/**
* Enables the `fluid` layout mode.
*/
fluid: true
},
/**
* Aside navigation configuration.
*
* @studio-icon fluent:document-page-24-regular
*/
aside: {
/**
* The level to which the navigation should be scaled.
*
* Use 0 to disable all nesting.
* Use 1 and more to display nested navigation in header and aside navigation.
*/
level: 0,
/**
* Specify if default collapsibles state globally for aside navigation.
*/
collapsed: false,
/**
* Paths to be excluded from aside navigation.
*
* @type {string[]}
*/
exclude: []
},
/**
* Header configuration.
*
* @studio-icon fluent:document-header-24-regular
*/
header: {
/**
* Title to be displayed in header or as aria-label if logo is defined
*
* Default to docus.title
*
* @studio-icon material-symbols:title
*/
title: '',
/**
* Logo configuration.
*
* Boolean to disable or use the `Logo.vue` component.
*
* String to be used as a name of a component.
*
* @example 'MyLogo'
*/
logo: false,
/**
* Toggle links icons in the header.
*/
showLinkIcon: false,
/**
* Paths to be excluded from header links.
*
* @type {string[]}
*
*/
exclude: []
},
/**
* Footer configuration
*
* @studio-icon fluent:document-footer-24-regular
*/
footer: {
/**
* Credits configuration
*
* Object configuring the credits part of footer.
*
* @type {false|object}
*
* @studio-icon material-symbols:copyright
*/
credits: {
/**
* Icon to show on credits
* @formtype Icon
*/
icon: 'IconDocus',
text: 'Powered by Docus',
href: 'https://docus.dev'
},
/**
* Text links to be added into center section of the footer.
*
* @studio-icon material-symbols:add-link
*/
textLinks: {
$schema: {
type: 'array',
items: {
type: 'object',
required: ['text', 'href'],
properties: {
href: {
type: 'string',
description: 'URL when clicking the link'
},
text: { type: 'string', description: 'Text of the link' },
target: { type: 'string', description: 'Target attribute of the link' }
}
}
}
},
/**
* Icons to be added to Social Icons in footer.
*
* @studio-icon material-symbols:add-link
*/
iconLinks: {
$schema: {
type: 'array',
items: {
type: 'object',
required: ['icon', 'href'],
properties: {
icon: { type: 'string', description: 'Icon name' },
href: {
type: 'string',
description: 'Link when clicking on the icon'
},
label: { type: 'string', description: 'Label of the icon' }
}
}
}
}
}
}
}
})