Skip to content

docs: use nuxi init -t ui command in installation #1648

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

Merged
merged 1 commit into from
Apr 10, 2024
Merged

docs: use nuxi init -t ui command in installation #1648

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions docs/content/1.getting-started/2.installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: 'Learn how to install and configure Nuxt UI in your application.'

## Setup

### Add to a Nuxt project

1. Add `@nuxt/ui` module to your project:

```bash
Expand All @@ -21,6 +23,19 @@ export default defineNuxtConfig({

That's it! You can now use all the components and composables in your Nuxt app ✨

### Use Nuxt starter

[Nuxt Starter](https://nuxt.new/) template makes it easy to get started with Nuxt UI.
The Nuxt Starter template is available from the `nuxi init` command.

```bash
npx nuxi@latest init -t ui
```



Please check [nuxt/starter](https://github.com/nuxt/starter/tree/ui) for details.

## Modules

Nuxt UI will automatically install the [@nuxtjs/tailwindcss](https://tailwindcss.nuxtjs.org/), [@nuxtjs/color-mode](https://color-mode.nuxtjs.org/) and [nuxt-icon](https://github.com/nuxt-modules/icon) modules for you.
Expand Down