Skip to content

Commit

Permalink
docs: mention about typescript, close #492
Browse files Browse the repository at this point in the history
  • Loading branch information
antfu committed Sep 1, 2024
1 parent 780514b commit 9f8655e
Show file tree
Hide file tree
Showing 4 changed files with 1,675 additions and 3,809 deletions.
29 changes: 25 additions & 4 deletions docs/content/1.packages/0.module.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,41 @@ npx nuxi module add eslint

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

:::callout{icon="i-catppuccin-typescript"}

If you are using TypeScript, you need to install the `typescript` in your project:

::code-group
```bash [yarn]
yarn add --dev typescript
```
```bash [npm]
npm install -D typescript
```
```bash [pnpm]
pnpm add -D typescript
```
```bash [bun]
bun add -D typescript
```
::

:::

### Manual Setup

::code-group
```bash [yarn]
yarn add --dev @nuxt/eslint eslint
yarn add --dev @nuxt/eslint eslint typescript
```
```bash [npm]
npm install --save-dev @nuxt/eslint eslint
npm install -D @nuxt/eslint eslint typescript
```
```bash [pnpm]
pnpm add -D @nuxt/eslint eslint
pnpm add -D @nuxt/eslint eslint typescript
```
```bash [bun]
bun add -D @nuxt/eslint eslint
bun add -D @nuxt/eslint eslint typescript
```
::

Expand Down
2 changes: 2 additions & 0 deletions docs/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,6 @@ export default defineNuxtConfig({
},
},
},

compatibilityDate: '2024-09-01',
})
11 changes: 6 additions & 5 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,22 @@
"preview": "nuxi preview"
},
"dependencies": {
"@vueuse/core": "^11.0.3"
},
"devDependencies": {
"@iconify-json/catppuccin": "^1.2.0",
"@iconify-json/ph": "^1.2.0",
"@iconify-json/simple-icons": "^1.2.1",
"@nuxt/content": "^2.13.2",
"@nuxt/devtools": "1.3.1",
"@nuxt/fonts": "^0.7.2",
"@nuxt/image": "1.7.0",
"@nuxt/image": "^1.8.0",
"@nuxt/ui": "^2.18.4",
"@nuxt/ui-pro": "^1.4.1",
"@nuxthq/studio": "^2.0.3",
"@nuxtjs/plausible": "^1.0.2",
"@vueuse/core": "^11.0.3",
"@vueuse/nuxt": "^11.0.3",
"nuxt": "^3.13.0",
"nuxt-og-image": "^3.0.0-rc.65"
},
"resolutions": {
"@nuxt/ui": "2.15.2"
}
}
Loading

0 comments on commit 9f8655e

Please sign in to comment.