Components
Components in shadcn-docs-nuxt you can use.
Docs Components
The Badges under each component title marks compatibility with other doc templates.
Alert
Callout
::callout
is an alias to ::alert
.
Read More
Badge
Code Group
npm run dev
::code-group
is a wrapper around ::tabs{variant="card"}
.
Card
Card Group
Icon
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.
npm i -D @iconify-json/collection-name
@iconify-json/lucide
and @iconify-json/vscode-icons
are installed by default.
Smart Icon
You can put iconify icons, emojis and urls in smart-icon
. Smart icon will render them automatically.
Iconify
Emojis
URL
Steps
Get Starter Template
npx nuxi@latest init <project-name> -t github:ZTL-UwU/shadcn-docs-nuxt-starter
Alternatively, you can clone or download the template from the GitHub repo.
Install Dependencies
npm install
Development Server
npm run dev -- -o
Multi-level headings
Specify the level of headings to use
::steps{level=5}
Available Headings
h1
through h6
. Defaults to h3
.
Field
'default'
The text required
is configurable in main.fieldRequiredText
.
Field Group
true
Tabs
Default Style
PostgreSQL column types
import { integer, pgTable } from 'drizzle-orm/pg-core';
export const table = pgTable('table', {
int: integer('int')
});
Card Style
Line Style
Stack
✨ Introducing Inspira UI
<template>
<RadiantText
class="inline-flex items-center justify-center px-4 py-1 transition ease-out hover:text-neutral-600 hover:duration-300 hover:dark:text-neutral-400"
:duration="5"
>
<span class="text-3xl font-bold">✨ Introducing Inspira UI</span>
</RadiantText>
</template>
npm install -D @inspira-ui/plugins
Stackable components:
div
- Code Blocks
alert
callout
read-more
code-group
card
tabs
Shortcut
Ctrl K
xs sm md
You can put meta
in the value
field to automatically display either ⌘ or Ctrl based on the platform.
Page Components
Hero
Effortless and Beautiful
Docs Template.
Beautifully designed Nuxt Content template with shadcn-vue. Customizable. Compatible. Open Source.
HeroAlt
Build your component library
Beautifully designed components that you can copy and paste into your apps.
Accordion
The value
prop in ::accordion-item
is auto-generated by default. You can set them to other unique values and put them in the default-value
prop of ::accordion
.