Plugin Options

Less than 1 minute

components

  • Type: AvailableComponent[]

    type AvailableComponent =
      | "Badge"
      | "BiliBili"
      | "CodePen"
      | "FontIcon"
      | "PDF"
      | "StackBlitz"
      | "VideoPlayer"
      | "YouTube";
    
  • Default: []

Components to be registered.

Available component names:

  • "Badge"
  • "BiliBili"
  • "CodePen"
  • "FontIcon"
  • "PDF"
  • "StackBlitz"
  • "VideoPlayer"
  • "YouTube"

addThis

Public ID of addThis.

backToTop

  • Type: boolean | number
  • Default: false

Whether enabling backToTop button. When setting a number, it will be used as BackToTop button threshold distance (in pixels), default is 300.

backToTopLocales

  • Type: BackToTopLocaleConfig

    interface BackToTopLocaleData {
      /**
       * Back to top button label text
       */
      backToTop: string;
    }
    
    interface BackToTopLocaleConfig {
      [localePath: string]: BackToTopLocaleData;
    }
    
  • Required: No

Locales config for BackToTop button.

Built-in Supported Languages
  • Simplified Chinese (zh-CN)
  • Traditional Chinese (zh-TW)
  • English (United States) (en-US)
  • German (de-AT)
  • Russian (ru-RU)
  • Ukrainian (uk-UA)
  • Vietnamese (vi-VN)
  • Portuguese (Brazil) (pt-BR)
  • Polish (pl-PL)
  • French (fr-FR)
  • Spanish (es-ES)
  • Slovak (sk-SK)
  • Japanese (ja-JP)
  • Turkish (tr-TR)
  • Korean (ko-KR)

iconAssets

  • Type: "iconfont" | "fontawesome" | `//${string}` | `http://${string}` | `https://${string}`
  • Required: No

Link of font icon asset, 'iconfont' and 'fontawesome' keywords are supported.

iconPrefix

  • Type: string
  • Default: Inferred from iconAssets

Class prefix of font icon

Loading...