Skip to content

Commit

Permalink
docs(installation):add UI template instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
atinux committed Nov 27, 2024
1 parent cd7ab3b commit a481410
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/content/1.getting-started/2.installation/1.nuxt.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Looking for the **Vue** version?

## Setup

### Add to a Nuxt project

::steps{level="4"}

#### Install the Nuxt UI v3 alpha package
Expand Down Expand Up @@ -79,6 +81,27 @@ It's recommended to install the [Tailwind CSS IntelliSense](https://marketplace.

::

### Use our Nuxt Starter

Start your project with a Nuxt template with Nuxt UI v3 pre-configured by using our [Nuxt UI Starter](https://github.com/nuxt/starter/tree/ui3).

Create a new project locally by running the following command:

```bash [Terminal]
npx nuxi@latest init -t ui3 <my-app>
```

::note
The `<my-app>` argument is the name of the directory where the project will be created, replace it with your project name.
::

Once the installation is complete, navigate into your project and start the development server:

```bash [Terminal]
cd <my-app>
npm run dev
```

## Options

You can customize Nuxt UI by providing options in your `nuxt.config.ts`.
Expand Down

0 comments on commit a481410

Please sign in to comment.