更改徽标和图标¶
安装MkDocs材料时,您可以立即访问8000多个 icons _可用于定制主题的特定部分和/或 在Markdown中编写文档时。不够?您还可以添加 [附加图标]只需最小的努力。
配置¶
标志¶
徽标可以更改为用户提供的图像(任何类型,包括“*.png”和 *.svg),或与主题捆绑在一起的任何图标。 将以下行添加到
mkdocs.yml`中:
-
Enter a few keywords to find the perfect icon using our icon search and click on the shortcode to copy it to your clipboard:
通常,标题和侧边栏中的徽标链接到 文档,与“site_url”相同。此行为可以更改 具有以下配置:
图标¶
favicon可以更改为指向用户提供的图像的路径 必须位于“文档”文件夹中。将以下行添加到mkdocs.yml
中:
网站图标¶
您在网站上看到的大多数图标,如导航图标,也可以更改。例如, 要更改页脚中的导航箭头,请在mkdocs.yml
中添加以下行:
以下是主题使用的可自定义图标的完整列表:
Icon name | Purpose |
---|---|
logo | See Logo |
menu | Open drawer |
alternate | Change language |
search | Search icon |
share | Share search |
close | Reset search, dismiss announcements |
top | Back-to-top button |
edit | Edit current page |
view | View page source |
repo | Repository icon |
admonition | See Admonition icons |
tag | See Tag icons and identifiers |
previous | Previous page in footer, hide search on mobile |
next | Next page in footer |
自定义¶
其他图标¶
为了使用自定义图标,[扩展主题]并创建一个名为的新文件夹 要用于覆盖的[custom_dir][custom_dir]中的.icons。 接下来,将您的
*.svg图标添加到
.icons`文件夹的子文件夹中。比如说 您下载并解压缩了Bootstrap图标集,并希望将其添加到 您的项目文档。项目的结构应该如下:
然后,在mkdocs.yml
中添加以下行:
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
现在,您可以在任何地方使用所有:fontawesome brands bootstrap:bootstrap图标 Markdown文件以及任何地方的图标都可以在mkdocs.yml
中使用。 但是,请注意,语法略有不同:
-
__在configuration__中使用图标:采用
*.svg
图标文件的路径 从“.icons”文件夹开始,删除文件扩展名,例如for `.icons/bootstrap/信封纸.svg,使用: -
在Markdown文件中使用图标:除了从 `如上所述,将.icons文件夹中的所有“/”替换为“-”,并将图标括起来 用两个冒号表示的短代码:
有关图标使用的更多说明,请参阅[图标参考]。