api report

Signed-off-by: Morgan Bentell <mbentell@spotify.com>

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;

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,