Configuration

Configure Hyperdocs using a hyperdocs.config.ts file in the root of your repository.

typescript

import { defineConfig } from '@hyperdocs/sdk'

export default defineConfig({
  name: 'My API Docs',
  logo: '/logo.svg',
  primaryColor: '#f26522',
  domain: 'docs.myapp.com',
  nav: [
    { label: 'Docs', href: '/getting-started' },
    { label: 'API', href: '/api-reference' },
  ],
})

Config Options

•name — the display name of your docs site

•logo — path to your logo image

•primaryColor — brand hex color

•domain — custom domain for your docs