Components
Components in shadcn-docs-nuxt you can use.
Docs Components
The Badges under each component title marks the compatibility with other doc templates.
Alert
Docus
Callout
Nuxt UI Pro
::callout is an alias to ::alert.
Read More
undocs
Read more in getting-started > writing > markdown
Read more in Nuxt website
Badge
Docus
Code Group
Docus
Nuxt UI Pro
::code-group is a wrapper around ::tabs{variant="card"}.
Card
Docus
Nuxt UI Pro
Card Group
Nuxt UI Pro
Icon
Docus
The icon component uses Nuxt Icon under the hood. Check out the usage guide from Nuxt Icon.
If you want to use other icons, it is highly recommended to install them locally, which is faster and more reliable on both SSR and client-side.
Terminal
@iconify-json/lucide and @iconify-json/vscode-icons are installed by default.
Steps
Get Starter Template
Alternatively, you can clone or download the template from the GitHub repo.
Install Dependencies
Development Server
Field
Nuxt UI Pro
Field required string
The description can be set as prop or in the default slot with full markdown support. Field Group
Nuxt UI Pro
validate (path?: string, opts: { silent?: boolean })Promise<T>
Triggers form validation. Will raise any errors unless opts.silent is set to true. clear (path?: string)void
Clears form errors associated with a specific path. If no path is provided, clears all form errors. getErrors (path?: string)FormError[]
Retrieves form errors associated with a specific path. If no path is provided, returns all form errors. setErrors (errors: FormError[], path?: string)void
Sets form errors for a given path. If no path is provided, overrides all errors. errorsRef<FormError[]>
A reference to the array containing validation errors. Use this to access or manipulate the error information. Tabs
Nuxt UI Pro
Landing Page Components
Hero
Effortless and Beautiful
Docs Template.
Beautifully designed Nuxt Content template with shadcn-vue.Customizable. Compatible. Open Source.