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
@@ -42,12 +42,12 @@ techdocs:
      # Defaults to false, which means that the techdocs-core plugin is always added to the mkdocs file.
      omitTechdocsCorePlugin: false

-    # (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: false
+      # (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: false

  # techdocs.builder can be either 'local' or 'external.
  # Using the default build strategy, if builder is set to 'local' and you open a TechDocs page,