Skip to content

Commit

Permalink
docs: use new nuxi module add command in installation (#829)
Browse files Browse the repository at this point in the history
* docs: use new `nuxi module add` command in installation

* chore: fix up wording

---------

Co-authored-by: Inesh Bose <dev@inesh.xyz>
  • Loading branch information
danielroe and ineshbose authored Apr 5, 2024
1 parent 11c980a commit 65238f9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,13 @@

## Quick Setup

1. Add `@nuxtjs/tailwindcss` dependency to your project
Add `@nuxtjs/tailwindcss` using the [Nuxt CLI](https://github.com/nuxt/cli) to your project

```bash
npx nuxi@latest module add tailwindcss
```

or add `@nuxtjs/tailwindcss` using your dependency manager

```bash
# Using pnpm
Expand All @@ -41,9 +47,7 @@ yarn add --dev @nuxtjs/tailwindcss
npm install --save-dev @nuxtjs/tailwindcss
```

*You can test latest additions on [Nightly Releases](https://tailwindcss.nuxtjs.org/getting-started/installation#nightly-releases)!*

2. Add `@nuxtjs/tailwindcss` to the `modules` section of `nuxt.config.{ts,js}`
and then to the `modules` section of `nuxt.config.{ts,js}`

```ts
export default defineNuxtConfig({
Expand All @@ -55,6 +59,8 @@ export default defineNuxtConfig({

That's it! You can now use Tailwind classes in your Nuxt app ✨

*You can test latest additions on [Nightly Releases](https://tailwindcss.nuxtjs.org/getting-started/installation#nightly-releases)!*

[📖 &nbsp;Read more](https://tailwindcss.nuxtjs.org/getting-started/)

## Contributing
Expand Down
6 changes: 5 additions & 1 deletion docs/content/1.getting-started/1.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ description: Using Tailwind CSS in your Nuxt project is only one command away.

::code-group

```bash [nuxi]
npx nuxi@latest module add tailwindcss
```

```bash [yarn]
yarn add -D @nuxtjs/tailwindcss
```
Expand All @@ -23,7 +27,7 @@ pnpm i -D @nuxtjs/tailwindcss

::

2. Add it to your `modules` section in your `nuxt.config`:
2. If not already done, add it to your `modules` section in your `nuxt.config`:

::code-group
```ts [Nuxt 3]
Expand Down

0 comments on commit 65238f9

Please sign in to comment.