Skip to content

defineDocsSiteConfig

Builds a documentation site’s Astro configuration.

The site’s source lives under <docs>/src (srcDir), so it never collides with the package’s own src/ and dist/. The API reference is generated into <docs>/src/content/docs/api with a matching <docs>/src/generated-sidebar.json, which this reads; run the generator first.

Import:

import { defineDocsSiteConfig } from '@mnaoumov/typescript-dev-toolkit/docs-site/astro-config';

Signature:

function defineDocsSiteConfig(config: DocsSiteConfig): AstroUserConfig<never, never, never>

Parameters:

Parameter Type Description
config DocsSiteConfig The site’s configuration.

Returns: AstroUserConfig<never, never, never> — The Astro configuration.