From 9ff9bb10bff997532aff1e8588734b924dd7e079 Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Sat, 11 Nov 2023 16:37:25 +0100 Subject: [PATCH] Docs: warn about installing third-party plugins --- docs/dev-guide/plugins.md | 2 ++ docs/user-guide/choosing-your-theme.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/dev-guide/plugins.md b/docs/dev-guide/plugins.md index 8d4a8c63..20218607 100644 --- a/docs/dev-guide/plugins.md +++ b/docs/dev-guide/plugins.md @@ -15,6 +15,8 @@ appropriate package name and install it using `pip`: pip install mkdocs-foo-plugin ``` +WARNING: Installing an MkDocs plugin means installing a Python package and executing any code that the author has put in there. So, exercise the usual caution; there's no attempt at sandboxing. + Once a plugin has been successfully installed, it is ready to use. It just needs to be [enabled](#using-plugins) in the configuration file. The [Catalog] repository has a large ranked list of plugins that you can install and use. diff --git a/docs/user-guide/choosing-your-theme.md b/docs/user-guide/choosing-your-theme.md index 8ababf5b..383ce193 100644 --- a/docs/user-guide/choosing-your-theme.md +++ b/docs/user-guide/choosing-your-theme.md @@ -196,6 +196,8 @@ theme supports the following options: A list of third party themes can be found at the [community wiki] page and [the ranked catalog][catalog]. If you have created your own, please add them there. +WARNING: Installing an MkDocs theme means installing a Python package and executing any code that the author has put in there. So, exercise the usual caution; there's no attempt at sandboxing. + [third party themes]: #third-party-themes [theme]: configuration.md#theme [Bootstrap]: https://getbootstrap.com/