Configuration

The layer is configured in three places:

• nuxt.config.ts — build-time options: site identity and the comarkDocs key.
• app.config.ts — branding and navigation: header, footer, assistant, OG images.
• Environment variables — secrets and runtime overrides.

nuxt.config.ts

Site identity

The site config drives canonical URLs, the sitemap, OG tags, and JSON-LD:

export default defineNuxtConfig({
  extends: ['comark-docs'],
  site: {
    url: 'https://docs.example.com',
    name: 'My Project',
  },
})

comarkDocs options

export default defineNuxtConfig({
  extends: ['comark-docs'],
  comarkDocs: {
    isr: 300,
    contentDir: 'docs/content',
    codeExplorer: {
      allowRepos: ['my-org/examples'],
    },
  },
})

agentDiscovery options

Markdown for agents is nuxt-agent-discovery, configured under agentDiscovery. The layer points it at the content instance, keeps versioned previews out of negotiation and seeds the MCP server card. Everything else is the module's defaults, and the option you are most likely to touch is the Agent Skills directory:

export default defineNuxtConfig({
  extends: ['comark-docs'],
  agentDiscovery: {
    skills: {
      dir: 'skills',
    },
  },
})

Each subdirectory holding a SKILL.md with a description is published at /.well-known/skills/. Skills are scanned at build time from the app, not from GitHub-sourced content, so a skill change needs a redeploy.

app.config.ts

Branding and navigation live in app.config.ts. Everything is optional — this playground's own config is a good starting point:

export default defineAppConfig({
  seo: {
    siteName: 'My Project',
  },
  header: {
    title: 'My Project',
    // Main navigation tabs; omit to derive one tab per top-level section
    nav: [
      { label: 'Documentation', sections: ['getting-started', 'writing'] },
      { label: 'API Reference', sections: ['reference'] },
    ],
    links: [
      { icon: 'i-simple-icons-github', to: 'https://github.com/my-org/my-repo', target: '_blank' },
    ],
  },
  footer: {
    icon: 'i-lucide-book',
    owner: 'My Company',
    links: [
      { icon: 'i-lucide-rss', to: '/rss.xml', target: '_blank', 'aria-label': 'RSS Feed' },
    ],
  },
})

All keys

Agent metadata

Two optional keys help AI agents understand and verify your site:

• docs.llms.description is emitted as the blockquote summary of llms.txt — the place the llms.txt spec reserves for key context. Use it to tell agents when to reach for your product: name the jobs it is right for and how an agent calls it — specific guidance, not marketing copy.
• docs.schemaOrg.organization is emitted as a top-level Organization JSON-LD node on the landing page. Give it a contactPoint (and optionally an address, a PostalAddress) so agents can verify the business behind the site.

export default defineAppConfig({
  docs: {
    llms: {
      description:
        'Use My Project to build documentation sites where Markdown is served at request time. ' +
        'Fetch any page as raw markdown at `/raw/<path>.md`, or request any page URL with `Accept: text/markdown`.',
    },
    schemaOrg: {
      applicationCategory: 'DeveloperApplication',
      organization: {
        contactPoint: { '@type': 'ContactPoint', contactType: 'customer support', email: 'support@example.com' },
        sameAs: ['https://github.com/my-org'],
      },
    },
  },
})

Environment variables

The GitHub repository, branch, and content directory are inferred from the local git checkout and VERCEL_GIT_* variables. Override them at runtime with NUXT_DOCS_* variables: NUXT_DOCS_GITHUB_OWNER, NUXT_DOCS_GITHUB_REPO, NUXT_DOCS_GITHUB_BRANCH, and NUXT_DOCS_CONTENT_DIR.

See Deploy on Vercel for where each variable is set in production.