Skip to content

Commit 47aaa12

Browse files
committed
docs: restructure installation guide and improve compatibility section
Improve readability by reorganizing the installation instructions into "New Project" and "Existing Project" sections. Replace the warning block with a clearer compatibility table and version history details. Add code groups for different package managers to enhance user experience.
1 parent f206bb2 commit 47aaa12

File tree

1 file changed

+60
-12
lines changed

1 file changed

+60
-12
lines changed

docs/guide/index.md

Lines changed: 60 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,74 @@ outline: deep
66

77
Welcome to the Vuetify Nuxt Module documentation.
88

9-
::: warning Breaking Changes
10-
From `v0.19.0` version, this module requires `Nuxt v3.15.0+`.
9+
## Compatibility
1110

12-
From `v0.10.0` version, this module requires `Nuxt v3.9.0+`.
11+
- **Nuxt**: v3.15.0+
12+
- **Vuetify**: v3.8+
13+
- **Builder**: Vite only (Webpack/Rspack are not supported)
1314

14-
From `v0.7.0` version, this module requires `Nuxt v3.6.5+`.
15+
::: details Version History
16+
- `v0.19.0`: Requires Nuxt `^3.15.0`
17+
- `v0.10.0`: Requires Nuxt `^3.9.0`
18+
- `v0.7.0`: Requires Nuxt `^3.6.5`
1519
:::
1620

17-
You can open the vuetify-nuxt-module GitHub repo in StackBlitz to start playing with the playground:
21+
## Installation
22+
23+
### New Project
24+
25+
The easiest way to start is using the official Vuetify creator:
26+
27+
::: code-group
28+
29+
```bash [npm]
30+
npm create vuetify@latest -- --platform=nuxt
31+
```
32+
33+
```bash [yarn]
34+
yarn create vuetify --platform=nuxt
35+
```
36+
37+
```bash [pnpm]
38+
pnpm create vuetify --platform=nuxt
39+
```
40+
41+
```bash [bun]
42+
bun create vuetify --platform=nuxt
43+
```
44+
45+
:::
46+
47+
You can also try it online on StackBlitz:
1848

1949
<a href="https://stackblitz.com/github/userquin/vuetify-nuxt-module" target="_blank" rel="noopener noreferrer">
2050
<img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz" width="162" height="32">
2151
</a>
2252

23-
## Installation
53+
### Existing Project
2454

25-
::: warning
26-
Requires Vite, will not work with Webpack
27-
:::
28-
```bash
55+
If you already have a Nuxt project, you can add the module via `nuxi`:
56+
57+
::: code-group
58+
59+
```bash [npm]
2960
npx nuxi@latest module add vuetify-nuxt-module
3061
```
3162

63+
```bash [yarn]
64+
yarn dlx nuxi@latest module add vuetify-nuxt-module
65+
```
66+
67+
```bash [pnpm]
68+
pnpm dlx nuxi@latest module add vuetify-nuxt-module
69+
```
70+
71+
```bash [bun]
72+
bun x nuxi@latest module add vuetify-nuxt-module
73+
```
74+
75+
:::
76+
3277
## Usage
3378

3479
::: info
@@ -43,8 +88,9 @@ Check out the [Globals](/guide/features/globals/) entry for more info.
4388

4489
Add `vuetify-nuxt-module` module to `nuxt.config.ts` and configure it:
4590

46-
```ts
47-
// Nuxt config file
91+
::: code-group
92+
93+
```ts [nuxt.config.ts]
4894
import { defineNuxtConfig } from 'nuxt/config'
4995

5096
export default defineNuxtConfig({
@@ -62,6 +108,8 @@ export default defineNuxtConfig({
62108
})
63109
```
64110

111+
:::
112+
65113
## Module Options
66114

67115
Check out the type declaration [src/types.ts](https://github.com/vuetifyjs/nuxt-module/blob/main/src/types.ts).

0 commit comments

Comments
 (0)