All options live in docgo.config.mjs and are optional.

docgo.config.mjs

import { defineConfig } from '@kyechan99/docgo';

export default defineConfig({
  title: 'My Docs',
});

Site

title

Type string

Default 'docgo'

Site name used in page titles and the brand fallback.

description

Type string

Default 'Static docs site powered by React + MDX'

Default page description.

docsDir

Type string

Default 'docs'

Source docs directory.

outDir

Type string

Default 'dist'

Build output directory.

baseUrl

Type string

Default '/'

URL prefix for generated assets and internal navigation under sub-path hosting.

siteUrl

Type string

Default ''

Absolute site URL for canonical URLs, sitemap entries, and absolute llms.txt links.

Extension

plugins

Type DocgoPlugin[]

Default []

Plugin hooks for config extension, MDX transforms, and page-generation side effects.

mdxComponents

Type Record<string, unknown>

Default {}

Components made available to MDX rendering.

clientPreviews

Type Record<string, ClientPreviewConfig>

Default {}

Client-only preview components available to MDX <ClientPreview /> islands.

previewProvider

Type PreviewProviderConfig

Default none

React wrapper applied around every client-only preview, similar to a Storybook decorator.

previewStylesheets

Type string[]

Default []

Docgo-managed stylesheet hrefs that should also be copied into preview iframes.

Head

head

Type HeadEntry[]

Default []

Structured head entries: [tag, attrs] or [tag, attrs, innerHTML].

headFile

Type string

Default 'head.html'

Raw HTML file injected into every page head. Missing files are ignored.

SEO

seo.favicon

Type FaviconConfig | FaviconConfig[]

Default none

Favicon link entries.

seo.image

Type string

Default none

Default Open Graph and Twitter preview image.

seo.twitter

Type string | { card?, site?, creator? }

Default none

Twitter/X card metadata. A string is treated as site.

seo.jsonLd

Type boolean | object | object[]

Default true

Emit default JSON-LD or custom JSON-LD objects.

seo.sitemap

Type boolean | { changefreq?, priority? }

Default true

Emit sitemap.xml when siteUrl is configured.

seo.robots

Type boolean | string | { rules?, sitemap? }

Default true

Emit robots.txt, or provide raw content/rules.

seo.llmsTxt

Type boolean | { title?, description? }

Default true

Emit llms.txt for AI/search consumption.

seo.noindex

Type boolean

Default false

Add noindex,nofollow globally unless page frontmatter overrides it.

logo

Type string | false | null | { src, alt? } | { light, dark, alt? }

Default null

Header brand logo. Use false to hide the logo mark.

siteTitle

Type string | false | null

Default null

Override or hide the brand text.

nav

Type NavItem[]

Default []

Header navigation. Supports links and dropdowns.

sidebar

Type SidebarItem[] | Record<string, SidebarItem[]>

Default {}

Sidebar tree or prefix-matched sidebar map.

socialLinks

Type { icon, link }[]

Default []

Header and footer social links with built-in icons for common platforms.

localizedNav

Type boolean

Default true

When true, brand and footer links stay in the current locale/version context.

Page Chrome

editLink

Type { pattern, text? } | null

Default null

Edit link. :path in pattern is replaced by the docs-relative source path.

lastUpdated

Type boolean | { text? }

Default false

Show the file last-updated date below the article.

outline

Type number | 'deep' | { level?, label? } | null

Default null

Controls which heading levels appear in the right-side outline.

footer

Type { message?, copyright? } | null

Default null

Compact site footer content. Set null to hide it.

docFooter

Type { prev?, next? } | null

Default null

Prev/next labels. Set either side to false to hide it.

search

Type boolean | SearchConfig

Default true

Enable built-in search, customize the index, or render a custom provider.

`docs` Theme Namespace

docs.menuTitle

Type string

Default 'Docs'

Mobile/sidebar menu title.

docs.tocTitle

Type string

Default 'On this page'

Right-side table-of-contents title.

docs.tocActiveMode

Type 'single' | 'multiple'

Default 'multiple'

Active TOC behavior.

docs.tocHeadings

Type (2 | 3 | 4 | 5 | 6 | 'h2' ... 'h6')[]

Default ['h2', 'h3']

Heading levels included in the page TOC.

docs.tocProgress

Type boolean

Default false

Show TOC scroll progress styling.

docs.header.fullWidth

Type boolean

Default false

Controls header width behavior.

docs.navbar.links

Type LinkConfig[]

Default []

Legacy navbar links. Prefer top-level nav for new sites.

docs.footer.text

Type string

Default 'Generated with @kyechan99/docgo'

Legacy footer text. Prefer top-level footer for new sites.

docs.footer.links

Type LinkConfig[]

Default []

Legacy footer links.

i18n

i18n.defaultLocale

Type string

Default 'en'

Default locale code. The default locale is omitted from URLs.

i18n.locales

Type LocaleConfig[]

Default English default

Available locales. Entries may override nav, sidebar, and footer.

Locale Entry

code

Type string

Default required

Locale code used in source paths.

label

Type string

Default code

Display label in the locale switcher.

link

Type string

Default none

Display-only metadata reserved for custom themes.

nav

Type NavItem[]

Default none

Locale-specific nav override.

sidebar

Type SidebarConfig

Default none

Locale-specific sidebar override.

footer

Type FooterConfig | null

Default none

Locale-specific footer override.

Versioning

versioning.defaultVersion

Type string

Default 'latest'

Default version code. The default version is omitted from URLs.

versioning.versions

Type { code, label? }[]

Default [{ code: 'latest', label: 'Latest' }]

Available documentation versions.

Types

`NavItem`

interface NavItem {
  text: string;
  link?: string;
  activeMatch?: string;
  items?: NavItem[];
}

`SidebarItem`

interface SidebarItem {
  text?: string;
  link?: string;
  collapsed?: boolean;
  items?: SidebarItem[];
}

`DocgoPlugin`

interface DocgoPlugin {
  name?: string;
  extendConfig?: (config: ResolvedConfig) => ResolvedConfig | void | Promise<ResolvedConfig | void>;
  transformMdx?: (source: string, context: TransformMdxContext) => string | Promise<string>;
  remarkPlugins?: any[] | ((context: TransformMdxContext) => any[]);
  rehypePlugins?: any[] | ((context: TransformMdxContext) => any[]);
  viteConfig?: (config: any, context: { command: 'serve' | 'build'; cwd: string }) => any | void;
  onPageGenerated?: (page: GeneratedPage) => void | Promise<void>;
}

interface TransformMdxContext {
  filePath: string;
  route: string;
  srcDir: string;
}

`SearchConfig`

interface SearchConfig {
  provider?: 'local' | 'custom';
  index?: boolean | { path?: string };
  label?: string;
  placeholder?: string;
  component?: (context: SearchRenderContext) => any;
}

interface SearchRenderContext {
  locale: string;
  version: string;
  baseUrl: string;
  indexPath: string;
}

`GeneratedPage`

interface GeneratedPage {
  route: string;
  outputPath: string;
  sourcePath: string;
  title: string;
  locale: string;
  version: string;
}

Config Reference

Site

Extension

Head

SEO

Branding and Navigation

Page Chrome

`docs` Theme Namespace

i18n

Locale Entry

Versioning

Types

`NavItem`

`SidebarItem`

`DocgoPlugin`

`SearchConfig`

`GeneratedPage`

Config Reference

#Site

#Extension

#Head

#SEO

#Branding and Navigation

#Page Chrome

#docs Theme Namespace

#i18n

#Locale Entry

#Versioning

#Types

#NavItem

#SidebarItem

#DocgoPlugin

#SearchConfig

#GeneratedPage

Site

Extension

Head

SEO

Branding and Navigation

Page Chrome

`docs` Theme Namespace

i18n

Locale Entry

Versioning

Types

`NavItem`

`SidebarItem`

`DocgoPlugin`

`SearchConfig`

`GeneratedPage`