docs(installation): improve starter sections

This commit is contained in:
Benjamin Canac
2025-01-10 15:33:54 +01:00
parent a3cf25f5cd
commit a3dbf7c27d
2 changed files with 25 additions and 2 deletions

View File

@@ -104,12 +104,12 @@ The `App` component provides global configurations and is required for **Toast**
### 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).
Start your project using the [nuxt/starter#ui3](https://github.com/nuxt/starter/tree/ui3) template with Nuxt UI v3 pre-configured.
Create a new project locally by running the following command:
```bash [Terminal]
npx nuxi@latest init -t ui3 <my-app>
npx nuxi init -t ui3 <my-app>
```
::note

View File

@@ -15,6 +15,8 @@ Looking for the **Nuxt** version?
## Setup
### Add to a Vue project
::steps{level="4"}
#### Install the Nuxt UI v3 alpha package
@@ -159,6 +161,27 @@ The `App` component provides global configurations and is required for **Toast**
::
### Use our Vue starter
Start your project using the [nuxtlabs/nuxt-ui3-vue-starter](https://github.com/nuxtlabs/nuxt-ui3-vue-starter) template with Nuxt UI v3 pre-configured.
Create a new project locally by running the following command:
```bash [Terminal]
npx nuxi init -t github:nuxtlabs/nuxt-ui3-vue-starter <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 `vite.config.ts`.