mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 20:19:34 +01:00
docs: update
This commit is contained in:
29
docs/content/1.getting-started/1.index.md
Normal file
29
docs/content/1.getting-started/1.index.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
---
|
||||||
|
title: Introduction
|
||||||
|
description: Nuxt UI biggest update ever, with a new design system, new components and a new way to use them.
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
|
---
|
||||||
|
|
||||||
|
We're excited to introduce the beta version of Nuxt UI v3, a powerful and flexible UI library for Nuxt applications. This new version brings significant improvements and new features to enhance your development experience.
|
||||||
|
|
||||||
|
## What's new?
|
||||||
|
|
||||||
|
### Radix Vue
|
||||||
|
|
||||||
|
### Tailwind CSS v4
|
||||||
|
|
||||||
|
### Tailwind Variants
|
||||||
|
|
||||||
|
### TypeScript support
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
To start using Nuxt UI v3 in your project, follow our [installation guide](/getting-started/installation). For a quick overview of the new features and changes, we'll publishe a migration guide soon.
|
||||||
|
|
||||||
|
## Feedback and contributions
|
||||||
|
|
||||||
|
As this is a beta release, we welcome your feedback and contributions. Please report any issues or suggestions on our [GitHub repository](https://github.com/nuxt/ui).
|
||||||
|
|
||||||
|
Stay tuned for more updates as we work towards the final release of Nuxt UI v3!
|
||||||
@@ -1,6 +1,9 @@
|
|||||||
---
|
---
|
||||||
title: Installation
|
title: Installation
|
||||||
description: 'Learn how to install and configure Nuxt UI in your application.'
|
description: 'Learn how to install and configure Nuxt UI in your application.'
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
---
|
---
|
||||||
description: ''
|
description: ''
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
Thanks to [`@nuxt/icon`](https://github.com/nuxt/icon), add 200,000+ ready to use icons to your Nuxt application based on [Iconify](https://iconify.design).
|
Thanks to [`@nuxt/icon`](https://github.com/nuxt/icon), add 200,000+ ready to use icons to your Nuxt application based on [Iconify](https://iconify.design).
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
---
|
---
|
||||||
description: 'Learn how to customize the look and feel of the components.'
|
description: 'Learn how to customize the look and feel of the components.'
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
This module relies on Nuxt [App Config](https://nuxt.com/docs/guide/directory-structure/app-config#app-config-file) file to customize the look and feel of the components at runtime with HMR (hot-module-replacement).
|
This module relies on Nuxt [App Config](https://nuxt.com/docs/guide/directory-structure/app-config#app-config-file) file to customize the look and feel of the components at runtime with HMR (hot-module-replacement).
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
---
|
---
|
||||||
description: 'Learn how to customize the look and feel of the components.'
|
description: 'Learn how to customize the look and feel of the components.'
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
This module relies on Nuxt [App Config](https://nuxt.com/docs/guide/directory-structure/app-config#app-config-file) file to customize the look and feel of the components at runtime with HMR (hot-module-replacement).
|
This module relies on Nuxt [App Config](https://nuxt.com/docs/guide/directory-structure/app-config#app-config-file) file to customize the look and feel of the components at runtime with HMR (hot-module-replacement).
|
||||||
|
|||||||
@@ -1 +1,3 @@
|
|||||||
title: Getting Started
|
title: Getting Started
|
||||||
|
navigation:
|
||||||
|
badge: null
|
||||||
|
|||||||
@@ -1,6 +1,9 @@
|
|||||||
---
|
---
|
||||||
title: defineShortcuts
|
title: defineShortcuts
|
||||||
description: 'Learn how to display and define keyboard shortcuts in your app.'
|
description: 'Learn how to display and define keyboard shortcuts in your app.'
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
Some components like [Dropdown](/components/dropdown), [Command Palette](/components/command-palette) and [Tooltip](/components/tooltip) support the display of keyboard shortcuts.
|
Some components like [Dropdown](/components/dropdown), [Command Palette](/components/command-palette) and [Tooltip](/components/tooltip) support the display of keyboard shortcuts.
|
||||||
|
|||||||
@@ -8,6 +8,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/CommandPalette.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/CommandPalette.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -8,6 +8,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/ContextMenu.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/ContextMenu.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -7,6 +7,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Drawer.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Drawer.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -8,6 +8,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Dropdown.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Dropdown.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -4,6 +4,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Form.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Form.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -8,6 +8,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/InputMenu.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/InputMenu.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -7,6 +7,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Modal.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Modal.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -8,6 +8,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/HorizontalNavigation.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/HorizontalNavigation.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -7,6 +7,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Pagination.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Pagination.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -7,6 +7,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Popover.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Popover.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -8,6 +8,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/SelectMenu.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/SelectMenu.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -7,6 +7,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Select.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Select.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -7,6 +7,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Divider.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Divider.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -7,6 +7,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Slideover.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Slideover.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -7,6 +7,9 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Notification.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Notification.vue
|
||||||
|
navigation:
|
||||||
|
badge:
|
||||||
|
label: Todo
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ export default defineNuxtConfig({
|
|||||||
nitro: {
|
nitro: {
|
||||||
prerender: {
|
prerender: {
|
||||||
routes: [
|
routes: [
|
||||||
'/getting-started/installation',
|
'/getting-started',
|
||||||
'/api/releases.json',
|
'/api/releases.json',
|
||||||
'/api/pulls.json'
|
'/api/pulls.json'
|
||||||
],
|
],
|
||||||
@@ -86,7 +86,7 @@ export default defineNuxtConfig({
|
|||||||
},
|
},
|
||||||
|
|
||||||
routeRules: {
|
routeRules: {
|
||||||
'/': { redirect: '/getting-started/installation', prerender: false },
|
'/': { redirect: '/getting-started', prerender: false },
|
||||||
'/components': { redirect: '/components/app', prerender: false }
|
'/components': { redirect: '/components/app', prerender: false }
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user