GenerateApiDocsParams

Options for generateApiDocs.

Import:

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

Signature:

export interface GenerateApiDocsParams

Properties

Property	Type	Description
rootDirectory	string	The repository root: the folder holding tsconfig.json and node_modules.
settings	ApiDocSettings	The settings every page and link is rendered with.
sourceDirectory	string	The folder whose modules are documented, normally <root>/src.

---

Links to this page:

• generateApiDocs