内置信息插件¶

信息插件是一个实用工具，旨在在[报告错误]或提出[变更请求]时创建自包含的minimal reproductions作为.zip文件，从而使我们维护者与您之间的沟通变得更加容易，因为我们有一个共同的基础可以进行工作。

目标¶

该插件帮助您准备一个最小化的复现，通过收集有关您的项目的环境和配置的必要信息。这使我们更容易修复错误，因为这要求您[升级到最新版本]并[移除您的自定义设置]。

遵循这些原则时，您可以放心地报告没有在后续版本中修复的错误，或不是由您的自定义设置引起的错误。更重要的是，您积极帮助我们尽快修复错误。

插件的输出是一个.zip文件，您可以与我们维护者分享。

每当您报告错误或有需要讨论的内容时，例如问题或变更请求，您应该附上一个小的、自包含的最小复现。可运行的示例有助于使沟通更加高效，使我们维护者有更多时间通过推动项目向前发展来惠及更多用户。最小复现对于错误报告是强制性的。

9.0.0 info – built-in

要开始使用内置信息插件，只需将以下行添加到mkdocs.yml中，并快速[创建一个最小复现]与我们维护者分享：

plugins:
  - info

信息插件内置于Material for MkDocs中，无需安装。

以下设置可用：

9.0.0 true

使用此设置来启用或禁用插件，在[构建您的项目]时。通常不需要指定此设置，但如果您想禁用插件，请使用：

plugins:
  - info:
      enabled: false

9.0.6 false

使用此设置来控制插件在[预览您的网站]时是否应启用。通常不需要指定此设置，但如果您想更改此行为，请使用：

plugins:
  - info:
      enabled_on_serve: true

此设置简化了创建和检查最小复现的过程，因为它允许快速迭代复现，而无需先禁用插件。

9.0.0 true

使用此设置来控制插件是否应从项目中创建.zip文件，或在版本检查后退出。此设置仅用于调试插件本身：

plugins:
  - info:
      archive: false

9.0.0 true

使用此设置来控制插件在未满足某个[要求]时是否应停止创建.zip文件。此设置仅在报告与自定义设置相关的错误时使用，该自定义设置[在我们的文档中明确提到]。您可以通过以下方式更改它：

plugins:
  - info:
      archive_stop_on_violation: false

如果您在报告错误时使用此设置，请解释为什么您认为包括自定义设置是必要的。如果您不确定，请先通过[创建讨论]向我们询问。