vuepress-plugin-homebadge for AntDocs #

首页徽标插件,目前仅适用于 AntDocs 主题。Github(opens new window)

Version NPM

安装 #

yarn add -D vuepress-plugin-homebadge
# OR npm install -D vuepress-plugin-homebadge

使用 #

module.exports = {
  plugins: ['homebadge']
}

配置选项 #

module.exports = {
  plugins: [
    ['homebadge',{
      selector: '.hero',
      repoLink: 'https://github.com/zpfz/vuepress-theme-antdocs',
      badgeLink: 'https://img.shields.io/github/stars/zpfz/vuepress-theme-antdocs?style=social',
      badgeGroup: [
        'https://img.shields.io/badge/build-passing-brightgreen?style=flat-square',
        'https://img.shields.io/npm/dt/vuepress-theme-antdocs?style=flat-square&color=red',
        'https://img.shields.io/github/license/zpfz/vuepress-theme-antdocs?style=flat-square&color=blue',
        'https://img.shields.io/npm/v/vuepress-theme-antdocs?style=flat-square'
      ]
    }]
  ]
}

选项 #

selector #

指定要注入徽标的父节点,该操作会在父节点内的最后一个元素追加徽标链接。

  • 类型:string
  • 默认值:.hero

指定一个 Github 库链接,当用户点击 Star 徽标时,会跳转至该链接。

  • 类型:string
  • 默认值:undefined

指定 Star 徽标链接,链接可从 shields.io(opens new window) 获取。

  • 类型:string
  • 默认值:undefined

badgeGroup #

指定 Star 徽标链接,链接可从 shields.io(opens new window) 获取。

  • 类型:array
  • 默认值:undefined
上次更新: 10/7/2020, 8:49:29 AM