Configuration

Customizing shadcn-docs-nuxt.

shadcn-docs-nuxt is configured through app.config.ts using a Function Merger.

app.config.ts 
export default defineAppConfig({
  shadcnDocs: () => ({
    header: {
      xxx
    },
    aside: {
      xxx
    },
    main: {
      xxx
    },
    xxx
  })
});

Fields Reference

Illustrative type declarations:

interface ILink {
  title?: string;
  icon?: string;
  to: string;
  target?: string;
}

interface INav {
  title: string;
  links?: (ILink & { description: string })[];
  to?: string;
  target?: string;
}

site

namestring
The site name shown on the tap title: <page> - <site_name>.

header

titlestring
The title shown on the header next to the icon.
showTitleboolean
Whether to show the title text on the header.
darkModeToggleboolean
Whether to show the dark mode toggle.
logo{ light: string; dark: string; }
The path to the logo image files. light is for the icon shown in light mode, dark is for the icon shown in dark mode.
navINav[]
The content of the navbar in the header.
linksILink[]
The links on the right of the header.

aside

useLevelboolean
Whether to use level-styled sidebar.
collapseboolean
Whether to collapse all collapsible by default.

main

breadCrumbboolean
Whether to show the bread crumb.
showTitleboolean
Whether to show the title section.
codeIconRecord<string, string>
The icon mapping for language / filename in the code group header.

footer

creditsstring
The credit text on the left side of the footer.
linksILink[]
The links on the right side of the footer.

toc

enableboolean
Whether to turn on the toc section.
titlestring
The title for the toc section.
linksILink[]
The links under the toc section.

search

enableboolean
Whether to turn on the search feature.
inAsideboolean
Whether to show the search bar in the sidebar.
Components
Components in shadcn-docs-nuxt you can use.
Themes
Add colors. Make it yours.