From e70aee4d695837d67abc4e4113ad13dce900e9ee Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Mon, 5 Aug 2024 18:54:50 +0200 Subject: [PATCH] docs: update --- docs/content/1.getting-started/1.index.md | 29 +++++++++++++++++++ .../1.getting-started/2.installation.md | 3 ++ docs/content/1.getting-started/3.icons.md | 3 ++ docs/content/1.getting-started/4.colors.md | 3 ++ docs/content/1.getting-started/5.theme.md | 3 ++ docs/content/1.getting-started/_dir.yml | 2 ++ .../2.composables/1.define-shortcuts.md | 3 ++ docs/content/3.components/command-palette.md | 3 ++ docs/content/3.components/context-menu.md | 3 ++ docs/content/3.components/drawer.md | 3 ++ docs/content/3.components/dropdown-menu.md | 3 ++ docs/content/3.components/form.md | 3 ++ docs/content/3.components/input-menu.md | 3 ++ docs/content/3.components/modal.md | 3 ++ docs/content/3.components/navigation-menu.md | 3 ++ docs/content/3.components/pagination.md | 3 ++ docs/content/3.components/popover.md | 3 ++ docs/content/3.components/select-menu.md | 3 ++ docs/content/3.components/select.md | 3 ++ docs/content/3.components/separator.md | 3 ++ docs/content/3.components/slideover.md | 3 ++ docs/content/3.components/toast.md | 3 ++ docs/nuxt.config.ts | 4 +-- 23 files changed, 93 insertions(+), 2 deletions(-) create mode 100644 docs/content/1.getting-started/1.index.md diff --git a/docs/content/1.getting-started/1.index.md b/docs/content/1.getting-started/1.index.md new file mode 100644 index 00000000..b6e5d241 --- /dev/null +++ b/docs/content/1.getting-started/1.index.md @@ -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! diff --git a/docs/content/1.getting-started/2.installation.md b/docs/content/1.getting-started/2.installation.md index 2b88cffe..7e48f3fa 100644 --- a/docs/content/1.getting-started/2.installation.md +++ b/docs/content/1.getting-started/2.installation.md @@ -1,6 +1,9 @@ --- title: Installation description: 'Learn how to install and configure Nuxt UI in your application.' +navigation: + badge: + label: Todo --- ## Setup diff --git a/docs/content/1.getting-started/3.icons.md b/docs/content/1.getting-started/3.icons.md index 40d1a045..9b656522 100644 --- a/docs/content/1.getting-started/3.icons.md +++ b/docs/content/1.getting-started/3.icons.md @@ -1,5 +1,8 @@ --- 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). diff --git a/docs/content/1.getting-started/4.colors.md b/docs/content/1.getting-started/4.colors.md index 715111d4..721471ce 100644 --- a/docs/content/1.getting-started/4.colors.md +++ b/docs/content/1.getting-started/4.colors.md @@ -1,5 +1,8 @@ --- 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). diff --git a/docs/content/1.getting-started/5.theme.md b/docs/content/1.getting-started/5.theme.md index dd804b88..881b11e0 100644 --- a/docs/content/1.getting-started/5.theme.md +++ b/docs/content/1.getting-started/5.theme.md @@ -1,5 +1,8 @@ --- 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). diff --git a/docs/content/1.getting-started/_dir.yml b/docs/content/1.getting-started/_dir.yml index bcd2ba14..d18c8e62 100644 --- a/docs/content/1.getting-started/_dir.yml +++ b/docs/content/1.getting-started/_dir.yml @@ -1 +1,3 @@ title: Getting Started +navigation: + badge: null diff --git a/docs/content/2.composables/1.define-shortcuts.md b/docs/content/2.composables/1.define-shortcuts.md index b9491bdd..091da9b9 100644 --- a/docs/content/2.composables/1.define-shortcuts.md +++ b/docs/content/2.composables/1.define-shortcuts.md @@ -1,6 +1,9 @@ --- title: defineShortcuts 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. diff --git a/docs/content/3.components/command-palette.md b/docs/content/3.components/command-palette.md index 934d86e0..f454e7db 100644 --- a/docs/content/3.components/command-palette.md +++ b/docs/content/3.components/command-palette.md @@ -8,6 +8,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/CommandPalette.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/context-menu.md b/docs/content/3.components/context-menu.md index 82562a83..2ebcee56 100644 --- a/docs/content/3.components/context-menu.md +++ b/docs/content/3.components/context-menu.md @@ -8,6 +8,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/ContextMenu.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/drawer.md b/docs/content/3.components/drawer.md index 8c1ccd23..561b079f 100644 --- a/docs/content/3.components/drawer.md +++ b/docs/content/3.components/drawer.md @@ -7,6 +7,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Drawer.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/dropdown-menu.md b/docs/content/3.components/dropdown-menu.md index f4488ca7..65b440fe 100644 --- a/docs/content/3.components/dropdown-menu.md +++ b/docs/content/3.components/dropdown-menu.md @@ -8,6 +8,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Dropdown.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/form.md b/docs/content/3.components/form.md index fe558a0b..f0906688 100644 --- a/docs/content/3.components/form.md +++ b/docs/content/3.components/form.md @@ -4,6 +4,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Form.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/input-menu.md b/docs/content/3.components/input-menu.md index 83c81ab0..40581718 100644 --- a/docs/content/3.components/input-menu.md +++ b/docs/content/3.components/input-menu.md @@ -8,6 +8,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/InputMenu.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/modal.md b/docs/content/3.components/modal.md index 75cb4077..50cc33af 100644 --- a/docs/content/3.components/modal.md +++ b/docs/content/3.components/modal.md @@ -7,6 +7,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Modal.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/navigation-menu.md b/docs/content/3.components/navigation-menu.md index e01ac60b..85e3d372 100644 --- a/docs/content/3.components/navigation-menu.md +++ b/docs/content/3.components/navigation-menu.md @@ -8,6 +8,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/HorizontalNavigation.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/pagination.md b/docs/content/3.components/pagination.md index f00610f9..b6f9212a 100644 --- a/docs/content/3.components/pagination.md +++ b/docs/content/3.components/pagination.md @@ -7,6 +7,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Pagination.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/popover.md b/docs/content/3.components/popover.md index da6073b7..994226b0 100644 --- a/docs/content/3.components/popover.md +++ b/docs/content/3.components/popover.md @@ -7,6 +7,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Popover.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/select-menu.md b/docs/content/3.components/select-menu.md index aed9f3d1..44c6598b 100644 --- a/docs/content/3.components/select-menu.md +++ b/docs/content/3.components/select-menu.md @@ -8,6 +8,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/SelectMenu.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/select.md b/docs/content/3.components/select.md index e41967a1..fc4807ca 100644 --- a/docs/content/3.components/select.md +++ b/docs/content/3.components/select.md @@ -7,6 +7,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Select.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/separator.md b/docs/content/3.components/separator.md index b47286ea..ba2d7733 100644 --- a/docs/content/3.components/separator.md +++ b/docs/content/3.components/separator.md @@ -7,6 +7,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Divider.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/slideover.md b/docs/content/3.components/slideover.md index 51460929..f5cd72bc 100644 --- a/docs/content/3.components/slideover.md +++ b/docs/content/3.components/slideover.md @@ -7,6 +7,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Slideover.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/content/3.components/toast.md b/docs/content/3.components/toast.md index ad9d7a6e..7496e416 100644 --- a/docs/content/3.components/toast.md +++ b/docs/content/3.components/toast.md @@ -7,6 +7,9 @@ links: - label: GitHub icon: i-simple-icons-github to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Notification.vue +navigation: + badge: + label: Todo --- ## Usage diff --git a/docs/nuxt.config.ts b/docs/nuxt.config.ts index 1354f08f..0c75214b 100644 --- a/docs/nuxt.config.ts +++ b/docs/nuxt.config.ts @@ -77,7 +77,7 @@ export default defineNuxtConfig({ nitro: { prerender: { routes: [ - '/getting-started/installation', + '/getting-started', '/api/releases.json', '/api/pulls.json' ], @@ -86,7 +86,7 @@ export default defineNuxtConfig({ }, routeRules: { - '/': { redirect: '/getting-started/installation', prerender: false }, + '/': { redirect: '/getting-started', prerender: false }, '/components': { redirect: '/components/app', prerender: false } },