Icon Plugin Config

Intro

The theme provides blog feature via @vuepress/plugin-icon. For instructions, please see Icon Intro.

Options

plugins.icon.assets

• Type: 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;

• Details:

  Icon assets to be used.

  The following keywords are supported and you may use other CDN links or even your own.:

  • iconify: Iconify
  • fontawesome: Font Awesome free icons only
  • fontawesome-with-brands: Font Awesome free icons and brand icons

plugins.icon.type

• Type: IconType

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

• Default: Inferred from the assets

• Details:

  Type of the icon, the plugin will try to infer the type from the assets, and fallbacks to unknown.

  Notably, the plugin can recognize:

  • iconfont css links
  • fontawesome kits
  • CDN links for fontawesome and iconify

plugins.icon.prefix

• Type: string

• Default: Infer from the assets and type

• Details:

  Prefix for the icon component. By default, the plugin will use:

  • iconfont icon- for iconfont type
  • fas fa- for fontawesome type
  • empty string for all other types

plugins.icon.markdown

• Type: boolean

• Default: true

• Details:

  Whether to enable icon syntax (::icon::) in markdown.