Skip to content

generateApiDocs

Generates the API reference pages and the sidebar.

Skips the work when neither the sources, the settings nor the generator changed since the last run.

Import:

import { generateApiDocs } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-docs';

Signature:

function generateApiDocs(options: GenerateApiDocsParams): Promise<void>

Parameters:

Parameter Type Description
options GenerateApiDocsParams The options.

Returns: Promise<void>


Links to this page: