Skip to content

buildDocsSite

Builds the site: generates the API reference and the Open Graph cards, runs astro build, then checks every link of the output. With DocsSiteConfig.repoHomepage on, it then checks the repository’s GitHub homepage against the site’s URL.

Import:

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

Signature:

function buildDocsSite(config: DocsSiteConfig): Promise<void>

Parameters:

Parameter Type Description
config DocsSiteConfig The site’s configuration.

Returns: Promise<void>