fix(techdocs): do not copy docs/README.md as docs/index.md

Signed-off-by: Phil Kuang <pkuang@factset.com>
This commit is contained in:
Phil Kuang
2022-04-04 12:54:46 -04:00
parent 6880fbfb32
commit 9ab9ce617e
9 changed files with 66 additions and 1 deletions
+9
View File
@@ -44,6 +44,15 @@ export interface Config {
* Pull the latest docker image
*/
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.
*/
legacyCopyReadmeMdToIndexMd?: boolean;
};
/**