图标设置

介绍

主题通过 @vuepress/plugin-icon 提供图标功能。使用说明请参阅 图标介绍。

选项

plugins.icon.assets

• 类型：IconAsset

  export type BuiltInIcon =
    | "fontawesome-with-brands"
    | "fontawesome"
    | "iconify";
  
  export type IconLink =
    | `//${string}`
    | `/${string}`
    | `http://${string}`
    | `https://${string}`;
  
  export type IconAsset = (BuiltInIcon | IconLink)[] | BuiltInIcon | IconLink;

• 详情：

  要使用的图标资源。

  支持以下关键字，你可以使用其他 CDN 链接甚至你自己的：

  • iconify：Iconify
  • fontawesome：仅限 Font Awesome 免费图标
  • fontawesome-with-brands：Font Awesome 免费图标和品牌图标

plugins.icon.type

• 类型：IconType

  export type IconType = "fontawesome" | "iconfont" | "iconify" | "unknown";

• 默认值：从 assets 中推断

• 详情：

  图标的类型，插件将尝试从资源中推断类型，并回退到 unknown。

  特别地，插件可以识别：

  • iconfont css 链接
  • fontawesome kits
  • fontawesome 和 iconify 的 CDN 链接

plugins.icon.prefix

• 类型：string

• 默认值：从 assets 和 type 推断

• 详情：

  图标组件的前缀。默认情况下，插件将使用：

  • iconfont icon- 用于 iconfont 类型
  • 空字符串用于所有其他类型