Configuration

Configure your documentation site

Configuration

Customize your documentation site using app.config.ts.

Site Configuration

Create an app.config.ts file in your project root:

export default defineAppConfig({
  docs: {
    title: 'My Docs',
    description: 'Documentation for my project',
    github: {
      owner: 'username',
      name: 'repo',
      url: 'https://github.com/username/repo',
      branch: 'main',
    },
  },
})

Configuration Options

docs.title

The site title displayed in the header.

docs: {
  title: 'My Documentation'
}

docs.description

The site description used for SEO.

docs: {
  description: 'Comprehensive documentation for my project'
}

docs.github

GitHub repository configuration for edit links.

docs: {
  github: {
    owner: 'username',
    name: 'repo',
    url: 'https://github.com/username/repo',
    branch: 'main',
  }
}

Environment Variables

The layer automatically detects environment variables:

VariableDescription
NUXT_SITE_URLSite URL
VERCEL_GIT_REPO_OWNERGitHub owner (Vercel)
GITHUB_REPOSITORYGitHub repository (GitHub Actions)

Next Steps