Nest config under mkdocs key.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-04-05 17:33:18 +02:00
parent 9ab9ce617e
commit bcf1a2496c
5 changed files with 21 additions and 15 deletions
@@ -46,13 +46,18 @@ export interface Config {
      pullImage?: boolean;

      /**
-       * (Optional and not recommended) Configures the techdocs generator to
-       * attempt to ensure an index.md exists falling back to using <docs-dir>/README.md
-       * or README.md in case a default <docs-dir>/index.md is not provided.
-       * Note that https://www.mkdocs.org/user-guide/configuration/#edit_uri behavior
-       * will be broken in these scenarios.
+       * Override behavior specific to mkdocs.
       */
-      legacyCopyReadmeMdToIndexMd?: boolean;
+      mkdocs?: {
+        /**
+         * (Optional and not recommended) Configures the techdocs generator to
+         * attempt to ensure an index.md exists falling back to using <docs-dir>/README.md
+         * or README.md in case a default <docs-dir>/index.md is not provided.
+         * Note that https://www.mkdocs.org/user-guide/configuration/#edit_uri behavior
+         * will be broken in these scenarios.
+         */
+        legacyCopyReadmeMdToIndexMd?: boolean;
+      };
    };

    /**