@vuepress/plugin-register-components

register-components plugin for VuePress

安装

yarn add -D @vuepress/plugin-register-components
# OR npm install -D @vuepress/plugin-register-components

使用

module.exports = {
  plugins: ['@vuepress/register-components']
}

选项

componentsDir

  • 类型: Array | String
  • 默认值: []

在这个目录下的所有组件将会被注册为全局组件,组件的命名将遵循在 .vuepress/components 中找到的组件的命名。

module.exports = {
  plugins: [
    [
      'register-components',
      {
        componentsDir: somepath
      }
    ]
  ]
}

components

  • 类型: { name: string, path: string }
  • 默认值: []

通过明确的名称和路径来注册组件。

module.exports = {
  plugins: [
    [
      'register-components',
      {
        components: [
          {
            name: 'V-Card',
            path: 'path/to/card.vue'
          }
        ]
      }
    ]
  ]
}

getComponentName

  • 类型: (file: string) => string
  • 默认值: file => file.replace(/\/|\\/g, '-')

自定义 componentsDir 中注册的组件的名称。