Skip to content

Commit 9f8655e

Browse files
committed
docs: mention about typescript, close #492
1 parent 780514b commit 9f8655e

File tree

4 files changed

+1675
-3809
lines changed

4 files changed

+1675
-3809
lines changed

docs/content/1.packages/0.module.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,41 @@ npx nuxi module add eslint
3737

3838
Once you start your Nuxt app, a `eslint.config.mjs` file will be generated under your project root. You can customize it as needed.
3939

40+
:::callout{icon="i-catppuccin-typescript"}
41+
42+
If you are using TypeScript, you need to install the `typescript` in your project:
43+
44+
::code-group
45+
```bash [yarn]
46+
yarn add --dev typescript
47+
```
48+
```bash [npm]
49+
npm install -D typescript
50+
```
51+
```bash [pnpm]
52+
pnpm add -D typescript
53+
```
54+
```bash [bun]
55+
bun add -D typescript
56+
```
57+
::
58+
59+
:::
60+
4061
### Manual Setup
4162

4263
::code-group
4364
```bash [yarn]
44-
yarn add --dev @nuxt/eslint eslint
65+
yarn add --dev @nuxt/eslint eslint typescript
4566
```
4667
```bash [npm]
47-
npm install --save-dev @nuxt/eslint eslint
68+
npm install -D @nuxt/eslint eslint typescript
4869
```
4970
```bash [pnpm]
50-
pnpm add -D @nuxt/eslint eslint
71+
pnpm add -D @nuxt/eslint eslint typescript
5172
```
5273
```bash [bun]
53-
bun add -D @nuxt/eslint eslint
74+
bun add -D @nuxt/eslint eslint typescript
5475
```
5576
::
5677

docs/nuxt.config.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,6 @@ export default defineNuxtConfig({
5454
},
5555
},
5656
},
57+
58+
compatibilityDate: '2024-09-01',
5759
})

docs/package.json

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,22 @@
99
"preview": "nuxi preview"
1010
},
1111
"dependencies": {
12+
"@vueuse/core": "^11.0.3"
13+
},
14+
"devDependencies": {
15+
"@iconify-json/catppuccin": "^1.2.0",
1216
"@iconify-json/ph": "^1.2.0",
1317
"@iconify-json/simple-icons": "^1.2.1",
1418
"@nuxt/content": "^2.13.2",
1519
"@nuxt/devtools": "1.3.1",
1620
"@nuxt/fonts": "^0.7.2",
17-
"@nuxt/image": "1.7.0",
21+
"@nuxt/image": "^1.8.0",
22+
"@nuxt/ui": "^2.18.4",
1823
"@nuxt/ui-pro": "^1.4.1",
1924
"@nuxthq/studio": "^2.0.3",
2025
"@nuxtjs/plausible": "^1.0.2",
21-
"@vueuse/core": "^11.0.3",
2226
"@vueuse/nuxt": "^11.0.3",
2327
"nuxt": "^3.13.0",
2428
"nuxt-og-image": "^3.0.0-rc.65"
25-
},
26-
"resolutions": {
27-
"@nuxt/ui": "2.15.2"
2829
}
2930
}

0 commit comments

Comments
 (0)