Skip to content

devDocsSite

Generates the API reference, then serves the site with astro dev until it is stopped.

Import:

import { devDocsSite } from '@mnaoumov/typescript-dev-toolkit/docs-site/docs-site-commands';

Signature:

function devDocsSite(config: DocsSiteConfig, astroArguments: readonly string[]): Promise<void>

Parameters:

Parameter Type Description
config DocsSiteConfig The site’s configuration.
astroArguments readonly string[] The arguments appended to astro dev, such as --port 4399. Defaults to the script’s own command-line arguments, so npm run docs:dev -- --port 4399 reaches Astro.

Returns: Promise<void>