centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Docs: warn about installing third-party plugins

Browse Source
This commit is contained in:
Oleh Prypin
2023-11-11 16:37:25 +01:00
parent 9e67e466f8
commit 9ff9bb10bf
2 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/dev-guide/plugins.md
View File

@@ -15,6 +15,8 @@ appropriate package name and install it using `pip`:
pip install mkdocs-foo-plugin 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 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] 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. repository has a large ranked list of plugins that you can install and use.

2
docs/user-guide/choosing-your-theme.md
View File

@@ -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. 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 [third party themes]: #third-party-themes
[theme]: configuration.md#theme [theme]: configuration.md#theme
[Bootstrap]: https://getbootstrap.com/ [Bootstrap]: https://getbootstrap.com/