Skip to content

内置信息插件

¥Built-in info plugin

信息插件是一个实用程序，其唯一目的是在报告错误或提出变更请求时创建自包含的最小复制品作为.zip文件，使我们的维护人员和您之间的沟通更加容易，因为我们有一个共同的工作基础。

¥The info plugin is a utility that is solely intended to create self-contained minimal reproductions as .zip files when reporting bugs or proposing change requests, making communication between us maintainers and you much easier, as we have a common ground to work on.

客观的

¥Objective

工作原理

¥How it works

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

¥The plugin helps you to prepare a minimal reproduction by collecting the necessary information about the environment and configuration of your project. This makes it easier for us to fix bugs, as it requires that you upgrade to the latest version and remove your customizations.

遵循这些原则，您可以放心，您不会报告已在后续版本中修复的错误，也不会报告由您的自定义操作导致的错误。更重要的是，您会积极帮助我们尽快修复错误。

¥When following these principles, you can be confident that you don't report a bug that has already been fixed in a subsequent release, or which is caused by one of your customizations. Even more importantly, you actively help us to fix the bug as quickly as possible.

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

¥The output of the plugin is a .zip file that you can share with us maintainers.

何时使用

¥When to use it

无论何时报告错误或需要讨论，例如提出问题或提出变更请求，您都应该附加一份简短、完整的最小复现文件。可运行的示例有助于提高沟通效率，让我们的维护人员有更多时间推动项目进展，从而造福更多用户。错误报告必须包含最小复现文件。

¥Whenever you're reporting a bug or have something to discuss, like a question or change request, you should attach a small, self-contained minimal reproduction. Runnable examples help to make communication much more efficient, giving us maintainers more time to benefit more users by pushing the project forward. Minimal reproductions are mandatory for bug reports.

配置

¥Configuration

9.0.0信息 – 内置

¥9.0.0 info – built-in

为了开始使用内置信息插件，只需将以下几行添加到mkdocs.yml ，并快速创建最小复制品以与我们维护者分享：

¥In order to get started with the built-in info plugin, just add the following lines to mkdocs.yml, and quickly create a minimal reproduction to share with us maintainers:

plugins:
  - info

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

¥The info plugin is built into Material for MkDocs and doesn't need to be installed.

一般的

¥General

可用的设置如下：

¥The following settings are available:

enabled

¥enabled

9.0.0真

¥9.0.0 true

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

¥Use this setting to enable or disable the plugin when building your project. It's normally not necessary to specify this setting, but if you want to disable the plugin, use:

plugins:
  - info:
      enabled: false

enabled_on_serve

¥enabled_on_serve

9.0.6错误

¥9.0.6 false

使用此设置可控制预览网站时是否启用该插件。通常无需指定此设置，但如果您想更改此行为，请使用：

¥Use this setting to control whether the plugin should be enabled when previewing your site. It's normally not necessary to specify this setting, but if you want to change this behavior, use:

plugins:
  - info:
      enabled_on_serve: true

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

¥This setting streamlines the process of creating and inspecting minimal reproductions, as it allows to quickly iterate on the reproduction without having to disable the plugin first.

档案

¥Archive

archive

¥archive

9.0.0真

¥9.0.0 true

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

¥Use this setting to control whether the plugin should create a .zip file from the project or exit after the version check. This setting is solely intended for debugging the plugin itself:

plugins:
  - info:
      archive: false

archive_stop_on_violation

¥archive_stop_on_violation

9.0.0真

¥9.0.0 true

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

¥Use this setting to control whether the plugin should stop creating the .zip file when one of the requirements is not satisfied. This setting must only be used when reporting a bug that is related to a customization explicitly mentioned in our documentation. You can change it with:

plugins:
  - info:
      archive_stop_on_violation: false

如果您在报告错误时使用此设置，请解释为什么您认为有必要包含自定义设置。如果您不确定，请先创建讨论来咨询我们。

¥If you're using this setting when reporting a bug, please explain why you think it is necessary to include customizations. If you're unsure, please ask us first by creating a discussion.