Skip to content

Commit 7fa25b9

Browse files
committed
docs: restructure documentation for better organization
1 parent 96f64b0 commit 7fa25b9

23 files changed

+62
-89
lines changed

β€Ždocs/.vitepress/config.tsβ€Ž

Lines changed: 46 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -56,47 +56,20 @@ export default withPwa(defineConfig({
5656
{
5757
text: 'Getting Started',
5858
link: '/guide/',
59-
}, {
60-
text: 'Globals',
61-
items: [{
62-
text: 'Globals',
63-
link: '/guide/globals/',
64-
}, {
65-
text: 'Global Components',
66-
link: '/guide/globals/global-components',
67-
}, {
68-
text: 'Directives',
69-
link: '/guide/globals/directives',
70-
}, {
71-
text: 'Lab Components',
72-
link: '/guide/globals/lab-components',
73-
}],
74-
}, {
75-
text: 'Icons',
76-
items: [{
77-
text: 'Icons',
78-
link: '/guide/icons/',
79-
}, {
80-
text: 'UnoCSS Preset Icons',
81-
link: '/guide/icons/unocss-preset-icons',
82-
}, {
83-
text: 'Font Icons',
84-
link: '/guide/icons/font-icons',
85-
}, {
86-
text: 'SVG Icons',
87-
link: '/guide/icons/svg-icons',
88-
}, {
89-
text: 'Integrations',
90-
link: '/guide/icons/integrations',
91-
}],
9259
},
9360
{
94-
text: 'I18N',
95-
link: '/guide/i18n',
61+
text: 'Configuration',
62+
link: '/guide/configuration/vuetify-options',
9663
},
9764
{
98-
text: 'Date',
99-
link: '/guide/date',
65+
text: 'Features',
66+
items: [
67+
{ text: 'Globals', link: '/guide/features/globals/' },
68+
{ text: 'Icons', link: '/guide/features/icons/' },
69+
{ text: 'I18N', link: '/guide/features/i18n' },
70+
{ text: 'Date', link: '/guide/features/date' },
71+
{ text: 'SSR', link: '/guide/features/ssr' },
72+
],
10073
},
10174
{
10275
text: `v${version}`,
@@ -123,58 +96,58 @@ export default withPwa(defineConfig({
12396
],
12497
sidebar: [
12598
{
126-
text: 'Guide',
99+
text: 'Getting Started',
127100
items: [
128-
{ text: 'Getting Started', link: '/guide/' },
129-
{ text: 'Compatibility Matrix', link: '/guide/compatibility-matrix' },
101+
{ text: 'Introduction', link: '/guide/' },
102+
{ text: 'Compatibility Matrix', link: '/guide/getting-started/compatibility' },
130103
],
131104
},
132105
{
133106
text: 'Configuration',
134107
items: [
135-
{ text: 'Vuetify Configuration File', link: '/guide/vuetify-configuration-file' },
136-
{ text: 'SASS Customization', link: '/guide/sass-customization' },
137-
{ text: 'Transform Asset URLs', link: '/guide/transform-asset-urls' },
138-
],
139-
},
140-
{
141-
text: 'Nuxt Integration',
142-
items: [
143-
{ text: 'Nuxt Layers and Module Hooks', link: '/guide/nuxt-layers-and-module-hooks' },
144-
{ text: 'Nuxt Runtime Hooks', link: '/guide/nuxt-runtime-hooks' },
145-
{ text: 'Server Side Rendering (SSR)', link: '/guide/server-side-rendering' },
108+
{ text: 'Vuetify Options', link: '/guide/configuration/vuetify-options' },
109+
{ text: 'SASS Customization', link: '/guide/configuration/sass' },
110+
{ text: 'Blueprints', link: '/guide/configuration/blueprints' },
111+
{ text: 'Transform Asset URLs', link: '/guide/configuration/transform-assets' },
146112
],
147113
},
148114
{
149115
text: 'Features',
150116
items: [
151-
{ text: 'Vuetify Composables', link: '/guide/vuetify-composables' },
152-
{ text: 'Vuetify Blueprints', link: '/guide/vuetify-blueprints' },
153-
{ text: 'Vuetify Locale Messages', link: '/guide/vuetify-locale-messages' },
154-
{ text: 'Internationalization', link: '/guide/i18n' },
155-
{ text: 'Date Support', link: '/guide/date' },
156-
],
157-
},
158-
{
159-
text: 'Globals',
160-
link: '/guide/globals/',
161-
items: [
162-
{ text: 'Global Components', link: '/guide/globals/global-components' },
163-
{ text: 'Directives', link: '/guide/globals/directives' },
164-
{ text: 'Lab Components', link: '/guide/globals/lab-components' },
117+
{
118+
text: 'Globals',
119+
collapsed: true,
120+
link: '/guide/features/globals/',
121+
items: [
122+
{ text: 'Global Components', link: '/guide/features/globals/global-components' },
123+
{ text: 'Directives', link: '/guide/features/globals/directives' },
124+
{ text: 'Lab Components', link: '/guide/features/globals/lab-components' },
125+
],
126+
},
127+
{
128+
text: 'Icons',
129+
collapsed: true,
130+
link: '/guide/features/icons/',
131+
items: [
132+
{ text: 'UnoCSS Preset Icons', link: '/guide/features/icons/unocss-preset-icons' },
133+
{ text: 'Font Icons', link: '/guide/features/icons/font-icons' },
134+
{ text: 'SVG Icons', link: '/guide/features/icons/svg-icons' },
135+
{ text: 'Integrations', link: '/guide/features/icons/integrations' },
136+
],
137+
},
138+
{ text: 'Internationalization', link: '/guide/features/i18n' },
139+
{ text: 'Date Support', link: '/guide/features/date' },
140+
{ text: 'SSR', link: '/guide/features/ssr' },
141+
{ text: 'Composables', link: '/guide/features/composables' },
165142
],
166-
collapsed: true,
167143
},
168144
{
169-
text: 'Icons',
170-
link: '/guide/icons/',
145+
text: 'Advanced',
171146
items: [
172-
{ text: 'UnoCSS Preset Icons', link: '/guide/icons/unocss-preset-icons' },
173-
{ text: 'Font Icons', link: '/guide/icons/font-icons' },
174-
{ text: 'SVG Icons', link: '/guide/icons/svg-icons' },
175-
{ text: 'Integrations', link: '/guide/icons/integrations' },
147+
{ text: 'Layers & Module Hooks', link: '/guide/advanced/layers-and-hooks' },
148+
{ text: 'Runtime Hooks', link: '/guide/advanced/runtime-hooks' },
149+
{ text: 'Locale Messages', link: '/guide/advanced/locale-messages' },
176150
],
177-
collapsed: true,
178151
},
179152
{
180153
text: 'Help',
File renamed without changes.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This module configures and registers Vuetify using Nuxt plugins via `vuetify:con
44

55
`vuetify:configuration` hook is for internal use and not meant to be used by third-party plugins or directly from your application.
66
This module will expose only the necessary Nuxt plugins to configure Vuetify using the options you've configured in your application:
7-
- [icons](/guide/icons/): this Nuxt plugin is always registered, you can write your own Nuxt plugin via `vuetifyOptions.icons.defaultSet = 'custom'` Nuxt configuration option, you have an example using UnoCSS in [Adding a new Vuetify icon set](/guide/icons/unocss-preset-icons#adding-a-new-vuetify-icon-set), replace the icons with your custom ones.
8-
- [i18n](/guide/i18n): this Nuxt plugin will be only registered when `@nuxtjs/i18n` module is configured.
9-
- [date](/guide/date): this Nuxt plugin will be only registered when `vuetifyOptions.date` Nuxt configuration option is configured.
7+
- [icons](/guide/features/icons/): this Nuxt plugin is always registered, you can write your own Nuxt plugin via `vuetifyOptions.icons.defaultSet = 'custom'` Nuxt configuration option, you have an example using UnoCSS in [Adding a new Vuetify icon set](/guide/features/icons/unocss-preset-icons#adding-a-new-vuetify-icon-set), replace the icons with your custom ones.
8+
- [i18n](/guide/features/i18n): this Nuxt plugin will be only registered when `@nuxtjs/i18n` module is configured.
9+
- [date](/guide/features/date): this Nuxt plugin will be only registered when `vuetifyOptions.date` Nuxt configuration option is configured.
1010

1111
If you need to update the Vuetify configuration before calling `createVuetify` and registering the plugin, you can use the `vuetify:before-create` hook in your Nuxt Plugin:
1212
```ts
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ The module supports Vuetify Blueprints, just add it to the `vuetifyOptions.bluep
77
- `locale` will be ignored, configure it using the `vuetifyOptions.locale` module option
88
- `date` will be ignored, configure it using the `vuetifyOptions.date` module option
99
- `icons` will be ignored, configure it using the `vuetifyOptions.icons` module option
10-
- `aliases` only supports defining aliases with [strings](/guide/globals/global-components.html#aliasing-global-component), using a component type will result in error (`Cannot start nuxt: Unexpected token '.'`)
10+
- `aliases` only supports defining aliases with [strings](/guide/features/globals/global-components.html#aliasing-global-component), using a component type will result in error (`Cannot start nuxt: Unexpected token '.'`)
File renamed without changes.
File renamed without changes.

docs/guide/vuetify-configuration-file.md renamed to docs/guide/configuration/vuetify-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Vuetify Configuration File
1+
# Vuetify Options
22

33
You can register Vuetify options using a file, the file path **must** be relative to the root folder.
44

File renamed without changes.

0 commit comments

Comments
Β (0)