11export default defineNuxtConfigSchema ( {
22 appConfig : {
3+ /**
4+ * Docus theme configuration.
5+ *
6+ * @studio -icon material-symbols:docs
7+ */
38 docus : {
49 /**
510 * Website title, used as header default title and meta title.
11+ *
12+ * @studio -icon material-symbols:title
613 */
714 title : 'Docus' ,
815 /**
916 * Website description, used for meta description.
17+ *
18+ * @studio -icon material-symbols:description
1019 */
1120 description : 'The best place to start your documentation.' ,
1221 /**
1322 * Cover image.
1423 *
1524 * @example '/cover.jpg'
25+ *
26+ * @studio -icon dashicons:cover-image
1627 */
1728 image :
1829 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png' ,
1930 /**
2031 * Social links.
2132 *
2233 * Will be used in Social Icons component, in AppHeader and AppFooter.
34+ *
35+ * @studio -icon material-symbols:share-outline
2336 */
2437 socials : {
2538 /**
2639 * Twitter social handle
2740 * @example 'nuxt_js'
41+ * @studio -icon simple-icons:twitter
2842 */
2943 twitter : '' ,
3044 /**
3145 * GitHub org or repository
3246 * @example 'nuxt/framework'
47+ * @studio -icon simple-icons:github
3348 */
3449 github : '' ,
50+ /**
51+ * Facebook page url
52+ * @example https://www.facebook.com/groups/nuxtjs
53+ * @studio -icon simple-icons:facebook
54+ */
3555 facebook : '' ,
56+ /**
57+ * Instagram page url
58+ * @example https://www.instagram.com/wearenuxt
59+ * @studio -icon simple-icons:instagram
60+ */
3661 instagram : '' ,
62+ /**
63+ * Instagram page url
64+ * @example https://www.youtube.com/@NuxtLabs
65+ * @studio -icon simple-icons:youtube
66+ */
3767 youtube : '' ,
68+ /**
69+ * Medium page url
70+ * @example https://medium.com/nuxt
71+ * @studio -icon simple-icons:medium
72+ */
3873 medium : ''
3974 } ,
75+
4076 aside : {
4177 /**
4278 * The level to which the navigation should be scaled.
@@ -61,6 +97,8 @@ export default defineNuxtConfigSchema({
6197 * Title to be displayed in header or as aria-label if logo is defined
6298 *
6399 * Default to docus.title
100+ *
101+ * @studio -icon material-symbols:title
64102 */
65103 title : '' ,
66104 /**
@@ -81,6 +119,7 @@ export default defineNuxtConfigSchema({
81119 * Paths to be excluded from header links.
82120 *
83121 * @type {string[] }
122+ *
84123 */
85124 exclude : [ ]
86125 } ,
@@ -91,6 +130,8 @@ export default defineNuxtConfigSchema({
91130 * Object configuring the credits part of footer.
92131 *
93132 * @type {false|object }
133+ *
134+ * @studio -icon material-symbols:copyright
94135 */
95136 credits : {
96137 /**
@@ -103,6 +144,8 @@ export default defineNuxtConfigSchema({
103144 } ,
104145 /**
105146 * Icons to be added to Social Icons in footer.
147+ *
148+ * @studio -icon material-symbols:add-link
106149 */
107150 iconLinks : {
108151 $schema : {
0 commit comments