Configuration

How to configure the docs-theme package.

Minimal app.config.ts
export default defineAppConfig({  docus: {    title: 'Docus',    description: 'My Docus Project',    url: 'http://docus.dev',    layout: 'default'  }})
Complete app.config.ts
export default defineAppConfig({  docus: {    title: 'Docus',    description: 'My Docus Project',    url: 'http://docus.dev',    image: '/social-card-preview.png',    socials: {      twitter: '@docus_',      github: 'nuxtlabs/docus',    },    github: {      root: 'content',      edit: true,      contributors: false    },    aside: {      level: 1,      filter: [],    },    header: {      title: false,      logo: true,      showLinkIcon: false    },    footer: {      credits: {        icon: 'IconDocus',        text: 'Powered by Docus',        href: 'https://docus.com',      },      icons: [        {          label: 'NuxtJS',          href: 'https://nuxtjs.org',          component: 'IconNuxtLabs',        },        {          label: 'Vue Telescope',          href: 'https://vuetelescope.com',          component: 'IconVueTelescope',        },      ],    }  }})
KeyTypeDefaultDescription
titlestringDocusWebsite title
descriptionstringMy Docus ProjectWebsite description
urlstringWebsite URL
layoutstringdefaultFallback layout to use
Socials
socialsobject{}Social links
socials.githubstringThe repository to use on GitHub links
socials.twitterstringThe account to use on Twitter links
socials.youtubestringThe channel to use on Youtube links
socials.instagramstringThe account to use on Instagram links
socials.facebookstringThe account to use on Facebook links
socials.mediumstringThe account to use on Medium links
socials.[social]objectOverride social or display custom one
socials.[social].labelstringA label to use for the social
socials.[social].iconstringA icon to use for the social
socials.[social].hrefstringA link to use for the social
Header
headerobjectHeader configuration
header.logobooleanWhether or not to use Logo.vue as the header logo
header.titlestringIf set to a string, will be used in the header
header.showLinkIconbooleanIf set to true links icons will show in the header
header.excludestring[]An array of path to exclude out from the header navigation
Aside
asideobjectAside configuration
aside.levelstring0Aside base level of nesting
aside.collapsedbooleanWill be used as default value for collapsible navigation categories
aside.excludestring[]An array of path to exclude out from the aside navigation
Footer
footerobjectFooter configuration
footer.creditsobjectAn object defining the bottom left credits
footer.credits.iconobjectThe icon to use for the credits
footer.credits.textobjectThe text to use for the credits
footer.iconsarray[]An array of icons to display in the footer
footer.icons[0].labelarrayA label to use for the icon
footer.icons[0].hrefarrayA link to use for the icon
footer.icons[0].iconarrayThe icon to use (can be a component name)
GitHub
githubobjectfalseGitHub integration configuration
github.editbooleanToggle "Edit this page on Github" component on documentation pages
github.contributorsbooleanToggle contributors component on documentation pages
github.rootstringThe root path to use for "Edit on Github" component