app.config Reference

Every field of app.config.ts with its type, default value and description, generated from the layer's nuxt.schema.ts so it always matches the published version. Follow the links to the guides for usage details.
View source

This page lists every field available in app/app.config.ts. The tables are generated from layer/nuxt.schema.ts; run pnpm docs:reference after changing the schema.

app.config is read at runtime. Module-level switches (feature flags, AI models and so on) live in nuxt.config.ts, see nuxt.config Options.

i18n

Multilingual and UI language settings

FieldTypeDefaultDescription
i18n.localestring"zh-CN"UI language when @nuxtjs/i18n is not enabled (e.g. zh-CN, en)

theme

Theme settings

FieldTypeDefaultDescription
theme.radiusnumber0.25Global border radius in rem
theme.blackAsPrimarybooleanfalseUse black as the primary color
theme.iconsstring"lucide"Global icon collection name
theme.fontstring"editorial"editorial uses serif headings, sans uses sans-serif everywhere
theme.grainbooleanfalseOverlay a paper grain texture on the page background

seo

SEO settings

FieldTypeDefaultDescription
seo.titleTemplatestring"%s"Page title template, with %s as the placeholder
seo.titlestring""Default site title
seo.descriptionstring""Default site description

Page header settings

FieldTypeDefaultDescription
header.titlestring""Title shown in the header
header.avatarstring""Avatar image URL
header.tostring"/"Link target when clicking the title
header.searchbooleantrueShow the search box
header.colorModebooleantrueShow the color mode toggle
header.linksarray[]Icon buttons on the right side of the header
header.navarray[]Top navigation links; label accepts a per-locale object and internal links get the locale prefix automatically
header.mobileNavarray[]Navigation links in the mobile menu; falls back to the desktop navigation when empty

docs

Docs sidebar settings

FieldTypeDefaultDescription
docs.categoriesobject{}Group sidebar navigation by top-level directory; keys are directory slugs, values are category lists

Page footer settings

FieldTypeDefaultDescription
footer.creditsstring""Copyright text shown in the footer
footer.socialsarray[]Social link buttons shown in the footer

toc

Table of contents settings

FieldTypeDefaultDescription
toc.titlestring""Title of the table of contents; uses the built-in translation when empty
toc.bottom.titlestring""Title of the area below the table of contents
toc.bottom.linksarray[]Link buttons shown below the table of contents

aside

Docs sidebar settings

FieldTypeDefaultDescription
aside.filter.enabledbooleanfalseShow a navigation filter at the top of the sidebar
aside.filter.placeholderstring""Placeholder of the filter input; uses the built-in translation when empty
aside.filter.thresholdnumber10Show the filter only when the current group has at least this many items
aside.filter.shortcutstring"/"Keyboard shortcut that focuses the filter; empty disables it

github

GitHub repository settings

FieldTypeDefaultDescription
github.ownerstring""GitHub repository owner
github.namestring""GitHub repository name
github.urlstring""Full GitHub repository URL
github.branchstring"main"Default branch name
github.rootDirstring""Root directory of the docs inside the repository
github.commitPathstring"src"Repository directory used by CommitChangelog to resolve component / composable source files
github.suffixstring"vue"File extension, without the dot, used by CommitChangelog to resolve source files
github.sincestring""Only fetch commits after this ISO date; empty means no limit
github.untilstring""Only fetch commits before this ISO date; empty means no limit
github.perPagenumber100Maximum number of commits fetched per file
github.authorstring""Only show commits by this author
github.casingstring"auto"File naming style: auto, kebab, camel or pascal
github.dateFormat.localestring"zh-CN"Locale used to format dates (e.g. zh-CN, en-US)
github.dateFormat.optionsobject{}Intl.DateTimeFormat options

aiChat

AI chat assistant settings

FieldTypeDefaultDescription
aiChat.floatingInputbooleantrueShow the floating input at the bottom of docs pages
aiChat.explainWithAibooleantrueShow the "Explain with AI" button in the docs sidebar
aiChat.faqQuestionsarray[]Suggested questions; a string array, a categorized object array, or an object keyed by locale
aiChat.shortcuts.focusInputstring"meta_i"Shortcut that focuses the floating input
aiChat.texts.titlestring""Title of the AI chat panel
aiChat.texts.clearChatstring""Text of the clear chat button
aiChat.texts.closestring""Text of the close button
aiChat.texts.placeholderstring""Placeholder of the floating input
aiChat.texts.lineBreakstring""Hint text for inserting a line break
aiChat.texts.triggerstring""Tooltip of the AI chat trigger button
aiChat.texts.explainWithAistring""Text of the "Explain with AI" button
aiChat.icons.triggerstring"i-custom-ai"Icon of the AI chat trigger button
aiChat.icons.explainstring"i-lucide-bot-message-square"Icon of the "Explain with AI" button
aiChat.icons.reasoningstring"i-lucide-brain"Icon of the reasoning block
aiChat.icons.clearChatstring"i-lucide-list-x"Icon of the clear chat button
aiChat.icons.closestring"i-lucide-panel-right-close"Icon of the close button
aiChat.icons.providersobject{}Icons per AI provider; keys are provider names, values are icon names
Copyright © 2024 - 2026