Skip to content

文档符号约定

主要说明了官方文档中所使用的各种图标和标记的含义

图标与标签说明

TMaterial for MkDocs 的官方文档中,许多内容前会附带一些 特殊符号,代表功能的可用范围、状态或类型。理解这些标记有助于你快速判断一个功能是否适合你使用。

图标或标记符号 名称(英文) 中文说明 是否必须配置 是否收费(Insiders)
❤️ Sponsors only 仅赞助者可用,属于付费 Insiders 专属功能 ✅ 是
🏷️ Version 功能引入的版本,提示使用时需满足最低版本要求
🏷️❤️ Version (Insiders) Insiders 专属版本功能 ✅ 是
⚙️ Default value 配置项默认值
⚙️(computed) Computed default 默认值为动态计算得出
⚙️(none) No default 没有默认值,需显式配置才能启用 ✅ 是
🗂️ Metadata property 元数据属性,可写入 Markdown 的 front matter 区
🔁 Multiple instances 插件支持在 plugins 中多次定义
🔧 Optional feature 可选功能,需手动启用
🧪 Experimental 实验性功能,未来可能更改或取消
🔌 Plugin 插件功能,有些内置,有些需额外安装 部分
✍️ Markdown extension 可扩展 Markdown 的语法功能
📛 Required value 必须配置的字段,否则无法生效或构建失败 ✅ 是
🎨 Customization 需要手动添加的自定义功能 ✅ 是
🧰 Utility 附加工具,如版本控制、脚本增强等