From a481410c5fde9c00d98a8f8550c53b11efcb6255 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Chopin?= Date: Wed, 27 Nov 2024 16:36:57 +0100 Subject: [PATCH] docs(installation):add UI template instructions --- .../2.installation/1.nuxt.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/content/1.getting-started/2.installation/1.nuxt.md b/docs/content/1.getting-started/2.installation/1.nuxt.md index c1b06a68..812dc1da 100644 --- a/docs/content/1.getting-started/2.installation/1.nuxt.md +++ b/docs/content/1.getting-started/2.installation/1.nuxt.md @@ -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 +``` + +::note +The `` 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 +npm run dev +``` + ## Options You can customize Nuxt UI by providing options in your `nuxt.config.ts`.