Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: use new nuxi module add command in installation #829

Merged
merged 2 commits into from
Apr 5, 2024
Merged

docs: use new nuxi module add command in installation #829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9df7590
docs: use new `nuxi module add` command in installation
danielroe Apr 3, 2024
7527b17
chore: fix up wording
ineshbose Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
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)!*

[📖  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
View file
Open in desktop
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