ComponentProps
Usage
Use the :component-props syntax in your Markdown documentation:
| Prop | Default | Type |
|---|---|---|
color | 'primary' | "error" | "primary" | "secondary" | "success" | "info" | "warning" | "neutral" |
size | 'md' | "xs" | "sm" | "md" | "lg" | "xl" |
variant | 'solid' | "link" | "solid" | "outline" | "soft" | "subtle" | "ghost"The variant of the component |
label | string | |
avatar | { src: string; alt?: string; text?: string; chip?: boolean | "circle"; size?: "xs" | "sm" | "md" | "lg" | "xl"; }display an avatar | |
disabled | boolean |
:component-props{slug="TestApi"}
API
Props
| Prop | Default | Type |
|---|---|---|
ignore | [
"activeClass",
"inactiveClass",
"exactActiveClass",
"ariaCurrentValue",
"href",
"rel",
"noRel",
"prefetch",
"prefetchOn",
"noPrefetch",
"prefetchedClass",
"replace",
"exact",
"exactQuery",
"exactHash",
"external",
"onClick",
"viewTransition",
"enterKeyHint",
"form",
"formaction",
"formenctype",
"formmethod",
"formnovalidate",
"formtarget"
] | string[]需要忽略的属性名数组 |
slug | 路由路径的最后一段 | string获取组件属性的 slug 标识 |
prose | boolean |
Changelog
Mermaid Diagrams
Enable optional Mermaid diagram support in Movk Nuxt Docs to render flowcharts, sequence diagrams, class diagrams, state diagrams, pie charts, Gantt charts, and entity-relationship diagrams. Includes automatic theme switching, lazy loading, copy code, and full-screen viewing, and is enabled in one step after installing mermaid and dompurify.
ComponentSlots
ComponentSlots automatically generates complete slot documentation for Vue components via nuxt-component-meta, displaying every slot's name, scoped variable types, and description in a single line of Markdown, greatly reducing the effort of writing API documentation by hand.