renaming(mkDocs): To mkdocs

Suggested by kmatyukhin on https://github.com/backstage/backstage/pull/15417

Signed-off-by: Renan Mendes Carvalho <aitherios@gmail.com>
Co-authored-by: Konstantin Matyukhin <kmatyukhin@gmail.com>

plugins/techdocs-node/api-report.md

@@ -88,6 +88,20 @@ export const getLocationForEntity: (
   scmIntegration: ScmIntegrationRegistry,
 ) => ParsedLocationAnnotation;
 
+// @public @deprecated (undocumented)
+export const getMkDocsYml: (
+  inputDir: string,
+  siteOptions?:
+    | {
+        name?: string | undefined;
+      }
+    | undefined,
+) => Promise<{
+  path: string;
+  content: string;
+  configIsTemporary: boolean;
+}>;
+
 // @public
 export const getMkdocsYml: (
   inputDir: string,

plugins/techdocs-node/src/stages/generate/helpers.test.ts

@@ -34,7 +34,7 @@ import {
 import {
   patchMkdocsYmlPreBuild,
   pathMkdocsYmlWithTechdocsPlugin,
-} from './mkDocsPatchers';
+} from './mkdocsPatchers';
 import yaml from 'js-yaml';
 
 const mockEntity = {

plugins/techdocs-node/src/stages/generate/index.ts

@@ -23,3 +23,10 @@ export type {
   GeneratorRunOptions,
   SupportedGeneratorKey,
 } from './types';
+import { getMkdocsYml } from './helpers';
+/**
+ * @public
+ * @deprecated
+ * Deprecated in favor of getMkdocsYml (lowercase 'd')
+ */
+export const getMkDocsYml = getMkdocsYml;

plugins/techdocs-node/src/stages/generate/techdocs.ts

@@ -34,7 +34,7 @@ import {
 import {
   patchMkdocsYmlPreBuild,
   pathMkdocsYmlWithTechdocsPlugin,
-} from './mkDocsPatchers';
+} from './mkdocsPatchers';
 import {
   GeneratorBase,
   GeneratorConfig,