mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 20:19:34 +01:00
docs(installation):add UI template instructions
This commit is contained in:
@@ -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
|
||||
@@ -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`.
|
||||
|
||||
Reference in New Issue
Block a user