allowed keys implementation

Signed-off-by: Bond Yan <bondy@spotify.com>
This commit is contained in:
Bond Yan
2026-02-26 17:27:23 -05:00
parent b1919bdf2a
commit cb7c6b1bc0
6 changed files with 119 additions and 3 deletions
+12
View File
@@ -64,6 +64,18 @@ export interface Config {
* List of mkdocs plugins which should be added as default to all mkdocs.yml files.
*/
defaultPlugins?: string[];
/**
* List of additional MkDocs configuration keys to allow beyond
* the default safe allowlist. This can introduce security vulnerabilities.
*
* WARNING: Some MkDocs configuration keys can execute arbitrary code. For example, the
* 'hooks' key allows running arbitrary Python code during documentation generation.
* Only use this in trusted environments where all mkdocs.yml files are audited.
*
* @see https://www.mkdocs.org/user-guide/configuration/#hooks
*/
dangerouslyAllowAdditionalKeys?: string[];
};
};