工具提示¶

技术文档中经常使用许多缩写词，这可能 需要额外的解释，特别是对于项目的新用户。对于这些 重要的是，MkDocs的Material使用Markdown扩展的组合来 启用全站术语表。

配置¶

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

markdown_extensions:
  - abbr
  - attr_list
  - pymdownx.snippets

请参阅其他配置选项：

• Abbreviations
• Attribute Lists
• Snippets

改进的工具提示¶

启用改进的工具提示后，MkDocs材质将取代浏览器的 使用漂亮的小工具提示渲染“title”属性的逻辑。 将以下行添加到mkdocs.yml中：

theme:
  features:
    - content.tooltips

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

• Content – 带有“标题”、永久链接和代码复制按钮的元素
• Header – 主页按钮、标题标题、调色板开关和存储库链接
• Navigation – 用省略号缩短的链接，即“”。..`

使用¶

添加工具提示¶

Markdown语法允许为每个链接指定一个“标题”，这将 启用[改进的工具提示]时，渲染为漂亮的工具提示。添加a 工具提示指向包含以下行的链接：

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

Tooltips can also be added to link references:

[Hover me][example]

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

For all other elements, a title can be added by using the Attribute Lists extension:

:material-information-outline:{ title="Important information" }

添加缩写¶

缩写可以通过使用类似于URL和 [脚注]，以“*”开头，紧随其后的是术语或 首字母缩略词应放在方括号内：

The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium

添加术语表¶

Snippets扩展可用于通过移动来实现简单的术语表 专用文件¹中的所有缩写，以及[自动附加]此文件到所有 具有以下配置的页面：

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium

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

watch:
  - includes