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
Preview
Code

Callout

Nuxt UI Pro

::callout is an alias to ::alert.

Read More

undocs
Preview
Code

Badge

Docus
Preview
Code

Code Group

Docus
Nuxt UI Pro
Preview
Code
npm
pnpm
yarn
bun
npm run dev

Card

Docus
Nuxt UI Pro
Preview
Code

Card Group

Nuxt UI Pro
Preview
Code

Icon

Docus
Preview
Code

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
npm i -D @iconify-json/collection-name

@iconify-json/lucide and @iconify-json/vscode-icons are installed by default.

Steps

Preview
Code

Get Starter Template

npm
pnpm
bun
npx nuxi@latest init <project-name> -t github:ZTL-UwU/shadcn-docs-nuxt-starter

Install Dependencies

npm
pnpm
bun
npm install

Development Server

npm
pnpm
bun
npm run dev -- -o

Field

Nuxt UI Pro
Preview
Code
Field required string
The description can be set as prop or in the default slot with full markdown support.

Field Group

Nuxt UI Pro
Preview
Code
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
Preview
Code

PostgreSQL column types

import { integer, pgTable } from 'drizzle-orm/pg-core';

export const table = pgTable('table', {
  int: integer('int')
});
Card Tab
Tab 2
Code Tab

Landing Page Components

Hero

Preview
Code
Release v1.0.0

Effortless and Beautiful
Docs Template.

Beautifully designed Nuxt Content template with shadcn-vue.
Customizable. Compatible. Open Source.