From 7939e0e64a0c331e193e444ca8697f4ac49873ba Mon Sep 17 00:00:00 2001 From: Morgan Bentell Date: Wed, 4 Oct 2023 14:03:00 +0200 Subject: [PATCH] api report Signed-off-by: Morgan Bentell --- plugins/techdocs-node/api-report.md | 6 ++++-- plugins/techdocs-node/src/stages/generate/helpers.ts | 7 ++----- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/plugins/techdocs-node/api-report.md b/plugins/techdocs-node/api-report.md index 11a9ecaa84..656db6ae36 100644 --- a/plugins/techdocs-node/api-report.md +++ b/plugins/techdocs-node/api-report.md @@ -89,9 +89,10 @@ export const getLocationForEntity: ( // @public @deprecated (undocumented) export const getMkDocsYml: ( inputDir: string, - siteOptions?: + options?: | { name?: string | undefined; + mkdocsConfigFileName?: string | undefined; } | undefined, ) => Promise<{ @@ -103,8 +104,9 @@ export const getMkDocsYml: ( // @public export const getMkdocsYml: ( inputDir: string, - siteOptions?: { + options?: { name?: string; + mkdocsConfigFileName?: string; }, ) => Promise<{ path: string; diff --git a/plugins/techdocs-node/src/stages/generate/helpers.ts b/plugins/techdocs-node/src/stages/generate/helpers.ts index 9e24a5edfe..1450a4afba 100644 --- a/plugins/techdocs-node/src/stages/generate/helpers.ts +++ b/plugins/techdocs-node/src/stages/generate/helpers.ts @@ -190,11 +190,8 @@ export const generateMkdocsYml = async ( * @public * * @param inputDir - base dir to be searched for either an mkdocs.yml or mkdocs.yaml file. - * @param options - ``` - * { - * name: default mkdocs site_name to be used with a ad hoc file default value is "Documentation Site" - * mkdocsConfigFileName (optional): a non-default file name to be used as the config - * }``` + * @param options - name: default mkdocs site_name to be used with a ad hoc file default value is "Documentation Site" + * mkdocsConfigFileName (optional): a non-default file name to be used as the config */ export const getMkdocsYml = async ( inputDir: string,