forked from nuxt-themes/docus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapp.config.ts
122 lines (120 loc) · 2.62 KB
/
app.config.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
export default defineAppConfig({
docus: {
/**
* Website title.
*/
title: 'Docus',
/**
* Website description.
*/
description: 'The best place to start your documentation.',
/**
* 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.
*/
socials: {
// twitter: '@nuxt_js',
// github: 'https://github.com/nuxt-themes/docus',
// facebook: '',
// instagram: '',
// youtube: '',
// medium: ''
},
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.
*/
exclude: []
},
header: {
/**
* Title to be displayed in header.
*/
title: '',
/**
* Logo configuration
*
* Boolean to disable or use the `Logo.vue` component.
* String to be used as a name of a component.
*/
logo: false,
/**
* Toggle links icons in the header.
*/
showLinkIcon: false,
/**
* Paths to be excluded from header links.
*/
exclude: []
},
footer: {
/**
* Credits configuration
*
* Object configuring the credits part of footer.
* Boolean to disable.
*/
credits: {
icon: 'IconDocus',
text: 'Powered by Docus',
href: 'https://docus.dev'
},
/**
* Icons to be added to Social Icons in footer.
*/
icons: []
}
}
})
declare module '@nuxt/schema' {
interface AppConfigInput {
docus?: {
title?: string
description?: string
image?: string
socials?: {
twitter?: string
github?: string
facebook?: string
instagram?: string
youtube?: string
medium?: string
},
aside?: {
level: number
exclude?: string[]
},
header?: {
title?: string,
logo?: boolean
showLinkIcon?: boolean
exclude?: string[]
},
footer?: {
credits?: boolean
iconLinks?: IconLink[]
}
}
}
}
interface IconLink {
href: string
icon: string
label?: string
}