Pages

Front matter attributes used in shadcn-docs-nuxt.

---
title: Front Matter
description: Front matter attributes used in shadcn-docs-nuxt.
icon: lucide:book-type
navTruncate: false
navBadges:
  - value: New
    type: lime
badges:
  - value: Docus
    to: https://docus.dev/api/components#alert
    target: _blank
  - value: Source
    icon: lucide:code
    to: https://github.com/ZTL-UwU/shadcn-docs-nuxt/blob/main/components/content/Alert.vue
    target: _blank
---

<!-- Content of the page -->

Parameters

titlestring
Title of the page. Defaults to the filename.
descriptionstring
Description of the page. Defaults to the first <p> of the page.
navigationboolean
true
Define if the page is included in the sidebar. Set it to false in index.md.
iconstring
The icon shown in the sidebar for the page.
navBadges[]
A list of badges appended to the end of the sidebar link.
navTruncateboolean
true
Whether to truncate the sidebar title.
badges[]
A list of badges shown at the bottom of page title.
tocboolean
true
Whether to show the toc section for this page.
asideboolean
true
Whether to show the aside section for this page.
editLinkboolean
true
Whether to show the edit link for this page.
prevNextboolean
true
Whether to show the previous & next page buttons.
breadcrumbboolean
true
Whether to show the breadcrumb.
Edit this page
Markdown
How to write docs with the MDC syntax.
Folders
Configure directory nodes via _dir.yml files.