docs: improve page descriptions and prev/next (#184)

Co-authored-by: Benjamin Canac <canacb1@gmail.com>
2026-01-23 16:30:45 +01:00 · 2023-05-19 10:33:09 +02:00
parent 1743ea91d5
commit e59fe42cc9
30 changed files with 92 additions and 19 deletions
--- a/docs/content/2.elements/1.avatar.md
+++ b/docs/content/2.elements/1.avatar.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display an image that represents a resource or a group of resources.
 ---

 ## Usage
--- a/docs/content/2.elements/2.badge.md
+++ b/docs/content/2.elements/2.badge.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a short text to represent a status or a category.
 ---

 ## Usage
--- a/docs/content/2.elements/3.button.md
+++ b/docs/content/2.elements/3.button.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Create a button with icon or link capabilities.
 ---

 ## Usage
--- a/docs/content/2.elements/4.dropdown.md
+++ b/docs/content/2.elements/4.dropdown.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a list of actions in a dropdown menu.
 headlessui:
  label: 'Menu'
  to: 'https://headlessui.com/vue/menu'
--- a/docs/content/2.elements/5.icon.md
+++ b/docs/content/2.elements/5.icon.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display an icon from Iconify library.
 ---

 ## Usage
--- a/docs/content/2.elements/6.kbd.md
+++ b/docs/content/2.elements/6.kbd.md
@@ -1,6 +1,7 @@
 ---
 github: true
 title: 'Keyboard Key'
+description: Display a keyboard key in a text block.
 navigation:
  title: 'Kbd'
 ---
--- a/docs/content/3.forms/1.input.md
+++ b/docs/content/3.forms/1.input.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display an input field.
 ---

 ## Usage
--- a/docs/content/3.forms/2.textarea.md
+++ b/docs/content/3.forms/2.textarea.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a textarea field.
 ---

 ## Usage
--- a/docs/content/3.forms/3.select.md
+++ b/docs/content/3.forms/3.select.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a select field.
 ---

 ## Usage
--- a/docs/content/3.forms/4.select-menu.md
+++ b/docs/content/3.forms/4.select-menu.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a select menu with advanced features.
 headlessui:
  label: 'Listbox'
  to: 'https://headlessui.com/vue/listbox'
--- a/docs/content/3.forms/5.checkbox.md
+++ b/docs/content/3.forms/5.checkbox.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a checkbox field.
 ---

 ## Usage
--- a/docs/content/3.forms/6.radio.md
+++ b/docs/content/3.forms/6.radio.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a radio field.
 ---

 ## Usage
--- a/docs/content/3.forms/7.toggle.md
+++ b/docs/content/3.forms/7.toggle.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a toggle field.
 headlessui:
  label: 'Switch'
  to: 'https://headlessui.com/vue/switch'
--- a/docs/content/4.navigation/1.vertical-navigation.md
+++ b/docs/content/4.navigation/1.vertical-navigation.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a vertical navigation.
 ---

 ## Usage
--- a/docs/content/4.navigation/2.command-palette.md
+++ b/docs/content/4.navigation/2.command-palette.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Add a customizable command palette to your app.
 headlessui:
  label: 'Combobox'
  to: 'https://headlessui.com/vue/combobox'
--- a/docs/content/5.overlays/1.modal.md
+++ b/docs/content/5.overlays/1.modal.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a modal within your application.
 headlessui:
  label: 'Dialog'
  to: 'https://headlessui.com/vue/dialog'
--- a/docs/content/5.overlays/2.slideover.md
+++ b/docs/content/5.overlays/2.slideover.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a dialog that slides in from the edge of the screen.
 headlessui:
  label: 'Dialog'
  to: 'https://headlessui.com/vue/dialog'
--- a/docs/content/5.overlays/3.popover.md
+++ b/docs/content/5.overlays/3.popover.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a non-modal dialog that floats around a trigger element.
 headlessui:
  label: 'Popover'
  to: 'https://headlessui.com/vue/popover'
--- a/docs/content/5.overlays/4.tooltip.md
+++ b/docs/content/5.overlays/4.tooltip.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display content that appears on hover next to an element.
 ---

 ## Usage
--- a/docs/content/5.overlays/5.context-menu.md
+++ b/docs/content/5.overlays/5.context-menu.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a menu that appears on right click.
 ---

 ## Usage
--- a/docs/content/5.overlays/6.notification.md
+++ b/docs/content/5.overlays/6.notification.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a toast notification in your app.
 ---

 ## Usage
--- a/docs/content/6.layout/1.card.md
+++ b/docs/content/6.layout/1.card.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a card for content with a header, body and footer.
 ---

 ## Usage
--- a/docs/content/6.layout/2.container.md
+++ b/docs/content/6.layout/2.container.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: A container lets you center and constrain the width of your content.
 ---

 ## Usage
--- a/docs/content/6.layout/3.skeleton.md
+++ b/docs/content/6.layout/3.skeleton.md
@@ -1,5 +1,6 @@
 ---
 github: true
+description: Display a placeholder while content is loading.
 ---

 ## Usage