工具提示¶

技术文档通常会使用许多缩略语，这些缩略语可能需要额外的解释，尤其是对于新用户而言。为了解决这些问题，Material for MkDocs 使用了一系列 Markdown 扩展来启用全站的术语表。

配置¶

此配置启用缩写，并允许构建一个简单的项目范围内的术语表，从中央位置获取定义。将以下行添加到 mkdocs.yml 中：

markdown_extensions:
  - abbr
  - attr_list
  - pymdownx.snippets

查看其他配置选项：

• 缩写
• 属性列表
• 片段

改进的工具提示¶

9.5.0

当启用改进的工具提示时，Material for MkDocs 会用美观的小工具提示替换浏览器对 title 属性的渲染逻辑。将以下行添加到 mkdocs.yml 中：

theme:
  features:
    - content.tooltips

现在，工具提示将为以下元素渲染：

• 内容 – 带有 title 的元素、永久链接和代码复制按钮
• 标题 – 首页按钮、标题、调色板切换和仓库链接
• 导航 – 被省略号缩短的链接，即 ...

使用¶

添加工具提示¶

Markdown 语法 允许为每个链接指定一个 title，当启用 改进的工具提示 时，将渲染为美观的工具提示。使用以下行为链接添加工具提示：

[Hover me](https://example.com "I'm a tooltip!")

工具提示也可以添加到链接引用中：

[Hover me][example]

  [example]: https://example.com "I'm a tooltip!"

对于所有其他元素，可以使用 属性列表 扩展添加 title：

:material-information-outline:{ title="重要信息" }

添加缩写¶

可以使用类似于 URL 和 脚注 的特殊语法定义缩写，以 * 开头，后面紧跟要在方括号中关联的术语或缩略语：

HTML 规范由 W3C 维护。

*[HTML]: 超文本标记语言
*[W3C]: 万维网联盟

添加术语表¶

可以使用 片段 扩展通过将所有缩写移动到专用文件中来实现简单的术语表¹，并使用以下配置 自动附加 该文件到所有页面：

*[HTML]: 超文本标记语言
*[W3C]: 万维网联盟

markdown_extensions:
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md

watch:
  - includes