Version: Next

getMkDocsYml()

Home > @backstage/plugin-techdocs-node > getMkDocsYml

Warning: This API is now obsolete.

Deprecated in favor of getMkdocsYml (lowercase 'd')

Signature:

getMkDocsYml: (inputDir: string, options?: {
    name?: string | undefined;
    mkdocsConfigFileName?: string | undefined;
} | undefined) => Promise<{
    path: string;
    content: string;
    configIsTemporary: boolean;
}>

Parameters

Parameter	Type	Description
inputDir	string
options	{ name?: string \| undefined; mkdocsConfigFileName?: string \| undefined; } \| undefined	(Optional)

**Returns:**

Promise<{ path: string; content: string; configIsTemporary: boolean; }>

Parameters​

Parameters