Material主题内配置启用

Material for MkDocs 中使用 FontAwesome 图标,可以通过配置和简单的 Markdown 语法实现。以下是具体步骤:

1. 安装 mkdocs-materialfontawesome 插件

首先,确保你已经安装了 Material for MkDocs:

1pip install mkdocs-material

如果还没有安装 fontawesome 的支持插件,可以通过以下命令安装 mkdocs-material-extensions,它内置了对 FontAwesome 的支持:

1pip install mkdocs-material-extensions

2. 启用 FontAwesome 图标支持

编辑你的 mkdocs.yml 配置文件,在 theme 部分添加 FontAwesome 图标支持:

1markdown_extensions:
2  - attr_list
3  - pymdownx.emoji:
4      emoji_index: !!python/name:material.extensions.emoji.twemoji
5      emoji_generator: !!python/name:material.extensions.emoji.to_svg

3. 使用 FontAwesome 图标

一旦启用了 FontAwesome 支持,可以在 Markdown 文档中通过以下方式使用图标:

1# 使用 FontAwesome 图标
2
3我们可以插入图标,比如::fontawesome-regular-face-laugh-wink:

这里的 :fontawesome-regular-face-laugh-wink: 是用来调用 FontAwesome 中的图标。
你可以根据需要替换图标名称,具体的图标名称可以在 FontAwesome 图标库 中找到。

4. 可选 - 加载特定的 FontAwesome 版本

如果需要特定版本的 FontAwesome,你可以在 extra_cssextra_javascript 部分手动引入 FontAwesome 的外部资源,用你自己的 FontAwesome Kit ID 替换 your-kit-id,这可以通过注册 FontAwesome 账号并创建 Kit 获得。

参考页面:Material for MkDocs Icons, Emojis,这里有 10000+ 图标可以使用,其包含以下库内容。

引用外部CSS扩展

该方法适用 MkDocs 的所有主题,要在 MkDocs 中使用 Font Awesome 图标,你可以按照以下步骤操作:

步骤 1: 添加 Font Awesome 到 MkDocs

首先,确保 Font Awesome 的 CSS 文件被包含在项目中。在 mkdocs.yml 文件中,添加 Font Awesome 的 CDN 链接到 extra_css 字段:

1extra_css:
2    - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css

步骤 2: 在 Markdown 中使用图标

在 Markdown 文件中,你可以直接使用 Font Awesome 的图标类来添加图标。例如,如果你想添加一个 GitHub 图标,可以使用以下 HTML 代码:

1<i class="fab fa-github"></i> Check out our GitHub repository!

或者,你可以使用内联 HTML 来添加图标:

1<span class="fa fa-github"></span> Check out our GitHub repository!

步骤 3: 使用图标与文本

为了方便使用,你可以创建一个带有图标和文本的组合链接:

1<a href="https://github.com/yourusername/yourrepository"><i class="fab fa-github"></i> GitHub</a>

步骤 4: 定制图标样式

你可以使用 CSS 来定制图标的样式,例如改变大小、颜色等。可以在 mkdocs.yml 中添加自定义 CSS:

1extra_css:
2    - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css
3    - styles/extra.css

extra.css 文件中,添加你的 CSS 规则:

1.fa-github {
2    color: #333;
3    font-size: 1.5em;
4}

步骤 5: 构建和查看结果

运行 mkdocs buildmkdocs serve 来构建你的文档或本地预览,检查图标是否按预期显示。